@ibnlanre/portal

v5.2.4

Published

5 months ago

A simple, lightweight and flexible state management library for React applications.

Downloads

0High
0Medium
0Low

ibnlanre

redux state store

@ibnlanre/portal

@ibnlanre/portal is a state management library designed to bridge the gap between simple state hooks and complex state machines. It provides an intuitive, type-safe approach to state management that grows with your application's needs.

Perfect for teams that:

Need a consistent state management pattern across their application
Want to leverage TypeScript's type system for safer code
Build complex React applications with nested state requirements
Require flexible state persistence options
Value code organization and maintainability

Whether you're building a small React component or a large-scale application, @ibnlanre/portal adapts to your needs without forcing specific architectural patterns or unnecessary complexity.

Features

@ibnlanre/portal offers powerful features for efficient state management:

📦 Flexible Store Types
- Manage both primitive values and complex nested objects
- Automatic type inference based on initial state
- Full TypeScript support with robust type checking
🔄 Intuitive State Management
- Simple, consistent API with $get, $set, and $act
- Deep partial updates for nested structures
- Safe handling of circular references
⚛️ Seamless React Integration
- Connect to components with the $use hook
- Context-based stores via createContextStore
- Co-locate state logic using actions-as-hooks
🔌 Built-in State Persistence
- Local Storage and Session Storage adapters
- Cookie Storage with signing support
- Customizable async storage adapters
🛠️ Advanced Capabilities
- Async operations with built-in loading states
- Deep dependency tracking for computed values
- Interface normalization for complex objects

Get started

This section guides you through setting up @ibnlanre/portal in your project.

Prerequisites

Before you begin, ensure your development environment includes:

Node.js (version 16.x or later recommended)
A package manager: npm, pnpm, or yarn
TypeScript (version 4.5 or later, if you are using TypeScript in your project)

Install the library

You can add @ibnlanre/portal to your project using a package manager or by including it from a CDN.

Using a package manager

Navigate to your project directory in the terminal.
Run one of the following commands, depending on your package manager:
npm
```
npm install @ibnlanre/portal
```
pnpm
```
pnpm add @ibnlanre/portal
```
yarn
```
yarn add @ibnlanre/portal
```
The library includes TypeScript definitions, so no separate @types package is needed.

Using a CDN

For projects that don't use a package manager (e.g., simple HTML pages or online playgrounds), you can include @ibnlanre/portal from a CDN:

Skypack

<script type="module">
  import { createStore } from "https://cdn.skypack.dev/@ibnlanre/portal";
  // Use createStore and other exports here
</script>

unpkg

<script src="https://unpkg.com/@ibnlanre/portal"></script>
<!-- The library will be available globally, e.g., window.Portal.createStore -->

jsDelivr

<script src="https://cdn.jsdelivr.net/npm/@ibnlanre/portal"></script>
<!-- The library will be available globally, e.g., window.Portal.createStore -->

Understand core concepts

Understanding these core concepts will help you use @ibnlanre/portal effectively.

What is a store?

A store is an object that holds your application's state. It allows you to read the state, update it, and subscribe to changes. @ibnlanre/portal stores can hold any kind of data, from simple primitive values to complex, nested objects.

Store types: Primitive and Composite

| Store Type | Description | Example Initial State | | --------------- | --------------------------------------------------------------------------- | --------------------------- | | Primitive Store | Manages a single primitive value (string, number, boolean, null, undefined) | 0, "Alex", true | | Composite Store | Manages an object with nested properties, each as a sub-store | { name: "Alex", age: 30 } |

@ibnlanre/portal distinguishes between two main types of stores, created automatically based on the initial state you provide:

Primitive Store: Manages a single, primitive value (e.g., a string, number, boolean, null, or undefined). At times, it can also manage a single object as a primitive-like store, where the entire object is treated as a single value.
- Example: A store holding a user's name as a string or a count as a number.
- Primitive stores provide methods to get the current value, set a new value, and subscribe to changes.
Composite Store: Manages an object, enabling nested state structures. Each property in a composite store's initial object can itself become a store instance (either primitive or composite), allowing for granular state management and access.
- Example: A store holding user details, where each property (like name, email, address) can be accessed and updated independently.
- Composite stores provide methods to get the current state, set new values for specific properties, and subscribe to changes at any level of the nested structure.

Both store types share a consistent API for getting, setting, and subscribing to state.

Immutability and reactivity

@ibnlanre/portal embraces immutability. When you update the state, the library creates a new state object instead of modifying the existing one. This helps prevent bugs and makes state changes predictable.

Tip: Stores are reactive. When a store's state changes, any components or subscribers listening to that store (or its parts) are notified, allowing your UI to update automatically.

⚠️ Important: Use Types, Not Interfaces

@ibnlanre/portal works best with type aliases rather than interfaces when defining your state structure. This is because createStore() expects a dictionary type (Record<string, unknown>), and interfaces don't automatically extend this constraint.

Why this matters:

Interfaces and dictionary types have different structural characteristics in TypeScript
Using interfaces can break type inference for composite stores
Arrays and other object types are properly typed as Record<string, any>, but interfaces would disrupt this consistency

✅ Recommended - Use type aliases:

// ✅ Good: Use type aliases
type UserState = {
  name: string;
  email: string;
  settings: {
    theme: "light" | "dark";
    notifications: boolean;
  };
};

const userStore = createStore<UserState>({
  name: "Alex",
  email: "[email protected]",
  settings: {
    theme: "light",
    notifications: true,
  },
});

❌ Avoid - Interfaces can cause type issues:

// ❌ Problematic: Interfaces can lead to unexpected type inference issues
interface UserState {
  name: string;
  email: string;
  settings: {
    theme: "light" | "dark";
    notifications: boolean;
  };
}

// This would be inferred as a PrimitiveStore instead of a CompositeStore
const userStore = createStore<UserState>({
  /* ... */
});

Alternative for interfaces: If you must work with existing interfaces (e.g., from APIs), use the normalizeObject() utility to convert them to dictionary-compatible types:

interface APIResponse {
  id: number;
  data: { value: string };
}

const apiData: APIResponse = {
  /* ... */
};
const normalizedData = normalizeObject(apiData);
const store = createStore(normalizedData);

Alternatively, you can use the Normalize type utility directly on the interface to convert it to a dictionary type:

import { Normalize } from "@ibnlanre/portal";

interface APIResponse {
  id: number;
  data: { value: string };
}

const apiData: Normalize<APIResponse> = {
  /* ... */
};
const store = createStore(apiData);

Configure your stores

@ibnlanre/portal is designed to work with minimal configuration. The primary configuration points are:

Store Initialization: When you call createStore(), you provide the initial state. This is the main configuration for a store's structure and default values.
Persistence Adapters: If you use state persistence, you configure adapters with options like storage keys and serialization functions.

Refer to the Persist state section for detailed configuration of each adapter.

Use the API: Reference and examples

This section provides a comprehensive reference for the @ibnlanre/portal API, with detailed explanations and examples.

Create stores: `createStore()`

The createStore() function is the primary way to initialize a new store. For specific scenarios or finer control, you can also use the direct store creation functions createPrimitiveStore() and createCompositeStore().

Using `createStore()`

Syntax:

createStore<S>(initialState: S | Promise<S>): Store<S>

initialState: The initial value for the store.
- If a primitive value (string, number, boolean, etc.) is provided, or an object that may be undefined or null, a PrimitiveStore<S> is created.
- If an object is provided, a CompositeStore<S> is created, allowing for nested properties to be accessed as individual stores.
- If a Promise is provided, the store will be initialized with the resolved value of the promise. The store will be empty until the promise resolves. The resolved value is treated as a single entity; if it's an object, it becomes the state of a primitive-like store, not a composite store with nested properties.
Returns: A Store instance, which can be a PrimitiveStore<S> or CompositeStore<S> depending on initialState.

Examples:

Creating a primitive store:

import { createStore } from "@ibnlanre/portal";

const countStore = createStore(0);
console.log(countStore.$get()); // Output: 0

const messageStore = createStore("Hello, world!");
console.log(messageStore.$get()); // Output: "Hello, world!"

Creating a composite store:

import { createStore } from "@ibnlanre/portal";

const userStore = createStore({
  id: 1,
  name: "Alex Johnson",
  email: "[email protected]",
  address: {
    street: "123 Main St",
    city: "Anytown",
  },
});

console.log(userStore.name.$get()); // Output: "Alex Johnson"
console.log(userStore.address.city.$get()); // Output: "Anytown"

Creating a store with asynchronous initialization:

import { createStore } from "@ibnlanre/portal";

async function fetchUserData(): Promise<{ id: number; name: string }> {
  return new Promise((resolve) => {
    setTimeout(() => resolve({ id: 1, name: "Fetched User" }), 1000);
  });
}

const userProfileStore = await createStore(fetchUserData());
// The store is now initialized as a primitive store with the fetched data.
// Note: userProfileStore holds { id: 1, name: "Fetched User" } as a single value.
// It's not created as a composite store despite being an object.

console.log(userProfileStore.$get()); // Output: { id: 1, name: "Fetched User" }

Using `createPrimitiveStore()`

Creates a store specifically for a single, primitive value (string, number, boolean, null, undefined, symbol, bigint).

Syntax:

createPrimitiveStore<S extends Primitives>(initialState: S): PrimitiveStore<S>

initialState: The initial primitive value.
Returns: A PrimitiveStore<S> instance.

When to use:

When you are certain the state will always be a primitive value and want to be explicit.
In rare cases where createStore() type inference for primitives might need disambiguation (though generally robust).

Example:

import { createPrimitiveStore } from "@ibnlanre/portal";

const isActiveStore = createPrimitiveStore(false);
console.log(isActiveStore.$get()); // false

Using `createCompositeStore()`

Creates a store specifically for an object, enabling nested state structures.

Syntax:

createCompositeStore<S extends GenericObject>(initialState: S): CompositeStore<S>

initialState: The initial object. Each property can become a nested store.
Returns: A CompositeStore<S> instance.

When to use:

When you are explicitly defining a store for an object structure.
If you are building higher-level abstractions on top of the library and need direct access to composite store creation.

Example:

import { createCompositeStore } from "@ibnlanre/portal";

const userDetailsStore = createCompositeStore({
  username: "guest",
  permissions: { read: true, write: false },
});

console.log(userDetailsStore.username.$get()); // "guest"
userDetailsStore.permissions.write.$set(true);

Note: Using createStore() is generally preferred as it automatically determines whether to create a primitive or composite store based on the initial state.

Create context stores: `createContextStore()`

The createContextStore() function creates React Context-based stores that solve a common problem: initializing stores with dynamic values that come from props or external sources. This is particularly useful when you need to create stores that depend on runtime data rather than static initial values.

Key Benefits:

Dynamic Store Creation: Initialize stores with runtime values from context, props, or API responses
Type-Safe Integration: Full TypeScript support with proper type inference
Maximum Flexibility: Full control over store initialization and memoization strategies
Flexible Architecture: Support for nested providers and multi-tenant applications
Developer Experience: Clear error messages and seamless React integration

The Problem it Solves:

Global stores are typically created outside of the React component lifecycle, so they can't be initialized with values from props or context. With a global store, you'd need to:

Create the store with a known default state
Sync props to the store using useEffect in every component that needs it

createContextStore eliminates this boilerplate by allowing you to pass a function that receives the context data needed before the store is initialized.

Syntax:

createContextStore<Context, ContextStore>(
  initializer: (context: Context) => ContextStore
): [StoreProvider, useStore]

initializer: A function that receives the context value and returns a store instance
Returns: An array containing [StoreProvider, useStore]

Basic Example:

import { createContextStore, createStore } from "@ibnlanre/portal";

interface UserProps {
  userId: string;
  theme: "light" | "dark";
}

// Create a context store for user settings
const [UserProvider, useUserStore] = createContextStore(
  (context: UserProps) => {
    return createStore(context);
  }
);

function UserProfile() {
  const store = useUserStore();
  const { userId, theme } = store.$get();

  return (
    <div style={{ background: theme === "dark" ? "#333" : "#fff" }}>
      <p>User ID: {userId}</p>
      <p>Theme: {theme}</p>
    </div>
  );
}

function App(props: UserProps) {
  return (
    <UserProvider value={props}>
      {/* The UserProfile component can now access the userId and theme from the context */}
      <UserProfile />
    </UserProvider>
  );
}

<App userId="123" theme="dark" />;

Advanced Example with Actions:

import { createContextStore, createStore, combine } from "@ibnlanre/portal";

type CounterContext = { initialCount: number };

const [CounterProvider, useCounterStore] = createContextStore(
  (context: CounterContext) => {
    const store = useSync(() => {
      const initialState = { count: context.initialCount };

      const actions = {
        increment: () => {
          counterStore.count.$set((prev) => prev + 1);
        },
        decrement: () => {
          counterStore.count.$set((prev) => prev - 1);
        },
        reset: () => {
          counterStore.count.$set(context.initialCount);
        },
      };

      const counterStore = createStore(combine(initialState, actions));
      return counterStore;
    }, [context.initialCount]);

    return store;
  }
);

function Counter() {
  const store = useCounterStore();
  const [count] = store.count.$use();

  return (
    <div>
      <span>Count: {count}</span>
      <button onClick={store.increment}>+</button>
      <button onClick={store.decrement}>-</button>
      <button onClick={store.reset}>Reset</button>
    </div>
  );
}

function App() {
  return (
    <CounterProvider value={{ initialCount: 10 }}>
      <Counter />
    </CounterProvider>
  );
}

Use Cases:

User-specific stores: Initialize stores with user data from authentication context
Feature flags: Create stores based on feature flag configuration
Multi-tenant applications: Initialize stores with tenant-specific configuration
Server-side rendering: Initialize stores with server-rendered data
Theme providers: Create theme-aware stores with runtime theme configuration

Note: The factory function passed to createContextStore runs on every render. You're responsible for memoizing values if needed. This design gives you complete freedom to use any hooks or memoization strategy within the factory function.

Use store instance methods

All store instances, whether primitive or composite, provide a core set of methods for interacting with the state.

`$get()`

Retrieves the current state of the store. Optionally, you can provide a selector function to compute a derived value from the state without altering the stored state.

Syntax:

$get(): S
$get<R>(selector: (currentState: S) => R): R

selector (optional): A function that takes the current state (S) as an argument and returns a derived value (R).
Returns: The current state (S) if no selector is provided, or the derived value (R) if a selector is provided.

Examples:

Getting the current state:

const countStore = createStore(10);
const currentCount = countStore.$get(); // 10

const userStore = createStore({ name: "Alex", role: "admin" });
const currentUser = userStore.$get(); // { name: "Alex", role: "admin" }
const userName = userStore.name.$get(); // "Alex"

Getting a derived value using a selector:

const countStore = createStore(10);
const doubledCount = countStore.$get((count) => count * 2); // 20
console.log(countStore.$get()); // 10 (original state is unchanged)

const userStore = createStore({ firstName: "Alex", lastName: "Johnson" });
const fullName = userStore.$get(
  (user) => `${user.firstName} ${user.lastName}`
); // "Alex Johnson"

`$set()`

Updates the store's state. You can pass a new value directly or provide an update function that receives the previous state and returns the new state.

For composite stores holding objects, $set performs a deep partial update. This means you only need to provide the properties you want to change, and @ibnlanre/portal will merge them intelligently with the existing state.

Syntax:

$set(newValue: S): void
$set(updater: (prevState: S) => S): void

newValue: The new state value to set directly.
updater: A function that takes the previous state (S) as an argument and returns the new state (S).
Returns: void.

Examples:

Setting a new value directly (Primitive Store):

const countStore = createStore(0);
countStore.$set(5);
console.log(countStore.$get()); // 5

Updating using a function (Primitive Store):

const countStore = createStore(5);
countStore.$set((prevCount) => prevCount + 1);
console.log(countStore.$get()); // 6

Partial update on a Composite Store:

const settingsStore = createStore({
  theme: "light",
  fontSize: 12,
  notifications: true,
});

// Update only theme and fontSize; notifications is preserved.
settingsStore.$set({ theme: "dark", fontSize: 14 });
// settingsStore.$get() is now { theme: "dark", fontSize: 14, notifications: true }

// Functional partial update
settingsStore.$set((prevSettings) => ({
  ...prevSettings, // Spread previous settings to preserve unspecified ones
  fontSize: prevSettings.fontSize + 2, // Only update fontSize
}));
// settingsStore.$get() is now { theme: "dark", fontSize: 16, notifications: true }

Updating nested properties in a Composite Store:

const userStore = createStore({
  profile: { name: "Alex", age: 30 },
  role: "user",
});

// Update nested property directly
userStore.profile.name.$set("Alexandra");
console.log(userStore.profile.name.$get()); // "Alexandra"

// Update part of the nested object
userStore.profile.$set({ age: 31 }); // name is preserved
// userStore.profile.$get() is { name: "Alexandra", age: 31 }

Note on arrays: When a part of your state is an array, and you use $set on the parent object containing that array, the entire array will be replaced if it's part of the update object. To modify array elements (e.g., add or remove items), access the array store directly or use functional updates on that specific array store.

const listStore = createStore({ items: [1, 2, 3], name: "My List" });

// This replaces the entire 'items' array but preserves 'name'.
listStore.$set({ items: [4, 5, 6] });
// listStore.$get() is { items: [4, 5, 6], name: "My List" }

// To add an item, update the 'items' store directly.
listStore.items.$set((prevItems) => [...prevItems, 7]);
// listStore.items.$get() is now [4, 5, 6, 7]

`$act()`

Subscribes a callback function to state changes. The callback receives the new state (and optionally the old state) whenever it changes. This method returns an unsubscribe function to stop listening for updates.

By default, the callback is invoked immediately with the current state upon subscription. To prevent this initial invocation, pass false as the second argument.

Syntax:

$act(subscriber: (newState: S, oldState?: S) => void, immediate?: boolean): () => void

subscriber: A function that is called when the state changes. It receives newState and optionally oldState.
immediate (optional, default true): If true, the subscriber is called immediately with the current state. If false, it's only called on subsequent changes. (On the initial immediate call, oldState is undefined.)
Returns: An unsubscribe function. Call this function to remove the subscription.

Examples:

Basic subscription:

const nameStore = createStore("Alex");

const unsubscribe = nameStore.$act((newName, oldName) => {
  console.log(`Name changed from "${oldName}" to "${newName}"`);
});
// Immediately logs: Name changed from "undefined" to "Alex"
// (oldState is undefined on the initial call if immediate: true)

nameStore.$set("Jordan"); // Logs: Name changed from "Alex" to "Jordan"

unsubscribe(); // Stop listening to changes
nameStore.$set("Casey"); // Nothing is logged

Subscription without immediate callback execution:

const statusStore = createStore("idle");

const unsubscribeNonImmediate = statusStore.$act((newStatus) => {
  console.log(`Status updated to: ${newStatus}`);
}, false); // `false` prevents immediate call

statusStore.$set("active"); // Logs: "Status updated to: active"

// Unsubscribe to stop listening
unsubscribeNonImmediate();

Subscribing to a composite store:

const settingsStore = createStore({ theme: "light", volume: 70 });

// Setting up subscription to changes in settings
const unsubscribeSettings = settingsStore.$act((newSettings) => {
  console.log("Settings updated:", newSettings);
});

// Changing the theme triggers the subscription
settingsStore.theme.$set("dark");

// Logs: Settings updated: { theme: "dark", volume: 70 }
unsubscribeSettings(); // Stop listening to changes

`$key()`

(CompositeStore only) Provides convenient access to deeply nested stores using a dot-separated string path. This method returns the nested store instance, allowing you to use its methods ($get, $set, $act, $use, $key) directly.

Syntax:

$key<N extends Store<any>>(path: string): N

path: A dot-separated string representing the path to the nested store (e.g., "user.preferences.theme"). TypeScript provides autocompletion for valid paths.
Returns: The nested Store instance (N).

Examples:

const appStore = createStore({
  user: {
    profile: {
      name: "Alex",
      email: "[email protected]",
    },
    preferences: {
      theme: "dark",
      language: "en",
    },
  },
  status: "active",
});

// Access nested stores using $key
const themeStore = appStore.$key("user.preferences.theme");

// Immediately get the current theme
console.log(themeStore.$get()); // "dark"

// Instantly update the theme
themeStore.$set("light");

// The update is reflected in the original store
console.log(appStore.user.preferences.theme.$get()); // "light"

$key can be used on intermediate stores as well. For example, if you want to access a nested property like user.preferences.language, you can do so directly:

// Accessing a nested store using $key
const preferencesStore = appStore.user.$key("preferences");

// Equivalent to appStore.$key("user.preferences.language")
const languageStore = preferencesStore.$key("language");
console.log(languageStore.$get()); // "en"

// Using methods on the store returned by $key
const unsubscribe = appStore.$key("user.preferences.theme").$act((newTheme) => {
  console.log("Theme via $key:", newTheme);
});

// Triggers the subscription
appStore.user.preferences.theme.$set("blue");
unsubscribe();

`$use()` (React Hook)

Connects your React components to an @ibnlanre/portal store. It works like React's useState hook, returning a tuple with the current state value (or a derived value) and a function to update the store's state.

The $use hook automatically subscribes the component to store changes and unsubscribes when the component unmounts, ensuring efficient re-renders.

Syntax:

$use(): [S, (newValue: S | ((prevState: S) => S)) => void]
$use<R>(
  selector: (currentState: S) => R,
  dependencies?: any[]
): [R, (newValue: S | ((prevState: S) => S)) => void]

selector (optional): A function that takes the current store state (S) and returns a transformed value (R) for the component.
dependencies (optional): An array of dependencies for the selector function. The selector is re-evaluated if any of these dependencies change (similar to React.useMemo).
Returns: A tuple:
1. currentStateOrDerivedValue: The current state (S) or the value returned by the selector (R).
2. setStateFunction: A function to update the store's state. It accepts either a new value of type S or an updater function (prevState: S) => S.

Examples:

Basic usage in a React component:

// src/stores/counter-store.ts
import { createStore } from "@ibnlanre/portal";
export const countStore = createStore(0);

// src/components/counter.tsx
import { countStore } from "../stores/counterStore";

function Counter() {
  const [count, setCount] = countStore.$use();

  return (
    <div>
      <p>Count: {count}</p>
      <button onClick={() => setCount(count + 1)}>Increment</button>
      <button onClick={() => setCount((prev) => prev - 1)}>
        Decrement
      </button>
      <button onClick={() => setCount(0)}>Reset</button>
    </div>
  );
}
export default Counter;

Using a selector with $use: Selectors compute derived values from the store state without modifying the original state. The selector is only re-evaluated when necessary, optimizing performance.

// In your component:
// Assume counterStore holds a number.
const [displayCount, setCount] = counterStore.$use(
  (currentCount) => `Current count is: ${currentCount}`
);
// If counterStore holds 0, displayCount is "Current count is: 0".
// setCount still expects a number to update the original counterStore.

return <p>{displayCount}</p>;

Using a selector with dependencies: This is useful when the selector depends on props or other state values. The dependencies can be any value, including primitive values, objects, or arrays. If the dependencies change, the selector will re-run to compute a new value.

import { useState } from "react";
import { displayStore } from "./store";

interface DisplayValueProps {
  prefixFromProp: string;
}

function DisplayValue({ prefixFromProp }: DisplayValueProps) {
  const [displayValue, setDisplayValue] = displayStore.$use(
    (value) => `${prefixFromProp}${value}`,
    [prefixFromProp] // Dependencies array
  );

  return (
    <div>
      <p>{displayValue}</p>
      <input
        type="text"
        value={displayValue}
        onChange={(e) => setDisplayValue(e.target.value)}
      />
    </div>
  );
}

Partial updates with objects using $use: When a store (or a part of a store accessed via $use) holds an object, the setState function returned by $use supports partial updates. Provide an object with only the properties you want to change.

// store.ts
import { createStore } from "@ibnlanre/portal";

export const userStore = createStore({
  name: "Alex",
  age: 30,
  city: "Anytown",
});

// user-profile.tsx
import { userStore } from "./store";

function UserProfile() {
  const [user, setUser] = userStore.$use();

  const handleAgeIncrease = () => {
    setUser({ age: user.age + 1 }); // Only age is updated; name and city are preserved.
  };

  const handleNameChange = (event: React.ChangeEvent<HTMLInputElement>) => {
    setUser({ name: event.target.value }); // Only name is updated.
  };

  return (
    <div>
      <input type="text" value={user.name} onChange={handleNameChange} />
      <p>Age: {user.age}</p>
      <p>City: {user.city}</p>
      <button onClick={handleAgeIncrease}>Increase Age</button>
    </div>
  );
}

Define actions: Functions in stores

You can include functions within the initial state object of a composite store. These functions become methods on the store, allowing you to co-locate state logic (actions) with the state itself. This is useful for encapsulating complex state transitions.

When defining actions, to update state, you must use the variable that holds the store instance. For example, if your store is const store = createStore(...), you would use store.property.$set(...) inside an action, not this.property.$set(...).

Examples:

Counter with actions:

import { createStore } from "@ibnlanre/portal";

const counterStore = createStore({
  value: 0,
  increment(amount: number = 1) {
    // To update 'value', use 'counterStore.value'
    counterStore.value.$set((prev) => prev + amount);
  },
  decrement(amount: number = 1) {
    counterStore.value.$set((prev) => prev - amount);
  },
  reset() {
    counterStore.value.$set(0);
  },
});

counterStore.increment(5);
console.log(counterStore.value.$get()); // 5

counterStore.decrement();
console.log(counterStore.value.$get()); // 4

counterStore.reset();
console.log(counterStore.value.$get()); // 0

Reducer pattern: You can structure actions to follow a reducer pattern if that fits your application's architecture.

import { createStore } from "@ibnlanre/portal";

type CounterAction =
  | { type: "INCREMENT"; payload: number }
  | { type: "DECREMENT"; payload: number }
  | { type: "RESET" };

const counterStore = createStore({
  value: 0,
  dispatch(action: CounterAction) {
    switch (action.type) {
      case "INCREMENT":
        // Use 'counterStore.value' to access $set
        counterStore.value.$set((prev) => prev + action.payload);
        break;
      case "DECREMENT":
        counterStore.value.$set((prev) => prev - action.payload);
        break;
      case "RESET":
        counterStore.value.$set(0);
        break;
    }
  },
});

counterStore.dispatch({ type: "INCREMENT", payload: 5 });
console.log(counterStore.value.$get()); // 5

counterStore.dispatch({ type: "RESET" });
console.log(counterStore.value.$get()); // 0

Actions as hooks

@ibnlanre/portal allows you to define functions within your store that can be used as React custom hooks. This powerful feature enables you to co-locate complex, stateful logic—including side effects managed by useEffect or component-level state from useState directly with the store it relates to.

To create an action that functions as a hook, simply follow React's convention:

prefix the function name with use
place it directly within the object you pass to createStore
then use it like any regular custom hook in your React components.

This pattern leverages React's own rules for hooks. It doesn't prevent the function from being recreated on re-renders (which is normal React behavior), but it provides an excellent way to organize and attach reusable hook logic to your store instance.

⚠️ Note: These functions are not automatically memoized. To prevent recreating hook logic on every render, define your store at the module level whenever possible. If you need to create a store inside a React component, use the useMemo hook to ensure the store is created based on stable dependencies.

Example:

Let's create a store with an action that uses useState and useEffect to automatically reset a message after a delay.

import { createStore } from "@ibnlanre/portal";
import { useState, useEffect } from "react";

export const notificationStore = createStore({
  message: "",
  setMessage(newMessage: string) {
    notificationStore.message.$set(newMessage);
  },
  useAutoResetMessage(initialMessage: string, delay: number) {
    const [internalMessage, setInternalMessage] = useState(initialMessage);

    useEffect(() => {
      if (internalMessage) {
        const timer = setTimeout(() => {
          setInternalMessage("");
        }, delay);
        return () => clearTimeout(timer);
      }
    }, [internalMessage, delay]);

    useEffect(() => {
      notificationStore.message.$set(internalMessage);
    }, [internalMessage]);

    return [internalMessage, setInternalMessage] as const;
  },
});

Using the hook action in a component:

import { notificationStore } from "../stores/notification-store";

export function NotificationManager() {
  const [message, setMessage] = notificationStore.useAutoResetMessage(
    "Welcome!",
    3000
  );

  const [globalMessage] = notificationStore.message.$use();

  return (
    <div>
      <p>Current message (from hook state): {message}</p>
      <p>Global message (from store): {globalMessage}</p>
      <button onClick={() => setMessage("Resetting in 3 seconds")}>
        Set Temporary Message
      </button>
    </div>
  );
}

In this example, useAutoResetMessage encapsulates its own state and side effects, just like a custom React hook, while still being able to interact with the global store. This pattern allows you to:

Reuse complex hook logic across components
Co-locate logic with the state it touches
Maintain a clean separation of concern between logic and UI

Asynchronous effects: `useAsync`

The useAsync hook provides a robust solution for handling asynchronous operations within your store actions. It automatically manages loading states, error handling, and data states, making it easy to work with promises and async functions.

Key Features:

Automatic state management: Tracks loading, error, and data states
Error handling: Catches and manages errors automatically
Dependency tracking: Re-runs when dependencies change
Promise support: Works with any promise-returning function

Basic Usage:

import { createStore, useAsync } from "@ibnlanre/portal";

type UserProfile = {
  id: string;
  name: string;
  email: string;
};

const userStore = createStore({
  users: [] as UserProfile[],
  profile: null as UserProfile | null,
  useUsers: async () => {
    const { data, loading, error } = useAsync(
      async ({ signal }) => {
        const response = await fetch("/api/users", { signal });

        if (!response.ok) throw new Error("Failed to fetch users");
        return response.json() as UserProfile[];
      } // No dependencies, runs once on mount
    );

    if (data) userStore.users.$set(data);
    return { userLoading: loading, userError: error };
  },
  useProfile: (userId: string) => {
    const { data, loading, error } = useAsync(
      async ({ signal }) => {
        if (!userId) throw new Error("User ID is required");

        const response = await fetch(`/api/users/${userId}`, { signal });

        if (!response.ok) throw new Error("Failed to fetch user");
        return response.json() as UserProfile;
      },
      [userId] // Dependency included in a list
    );

    if (data) userStore.profile.$set(data);
    return { profileLoading: loading, profileError: error };
  },
});

Usage in React component:

interface UserProfileComponentProps {
  userId: string;
}

function UserProfileComponent({ userId }: UserProfileComponentProps) {
  const { profileLoading: loading, profileError: error } =
    userStore.useProfile(userId);
  const [profile] = userStore.profile.$use();

  if (loading) return <div>Loading...</div>;
  if (error) return <div>Error: {error.message}</div>;
  if (!profile) return <div>No profile found</div>;

  return (
    <div>
      <h1>{profile.name}</h1>
      <p>{profile.email}</p>
    </div>
  );
}

Memoized computations: `useSync`

The useSync hook provides a useMemo implementation with deep dependency verification. It's designed to compute and memoize values based on complex dependencies, with automatic re-computation when any part of the dependency tree changes.

Key Features:

Deep dependency tracking: Performs deep equality checks on complex objects and arrays
Automatic memoization: Only re-computes when dependencies actually change
Complex object support: Handles nested objects, arrays, and circular references
Type safety: Full TypeScript support with proper type inference
Performance optimized: Avoids unnecessary re-computations

Basic Usage:

import { createStore, useSync } from "@ibnlanre/portal";

const settingsStore = createStore({
  fontSize: 16,
  theme: "light" as "light" | "dark",
  language: "en",
  useDisplaySettings: () => {
    const [theme] = settingsStore.theme.$use();
    const [fontSize] = settingsStore.fontSize.$use();
    const [language] = settingsStore.language.$use();

    // This will only re-compute when theme, fontSize, or language change
    return useSync(() => {
      return {
        cssVariables: {
          "--theme": theme,
          "--font-size": `${fontSize}px`,
          "--language": language,
        },
        className: `theme-${theme} lang-${language}`,
        styleObject: {
          fontSize: fontSize,
          colorScheme: theme,
        },
      };
    }, [theme, fontSize, language]);
  },
});

function ThemedComponent() {
  const { className, styledObject, cssVariables } =
    settingsStore.useDisplaySettings();

  return (
    <div className={className} style={styleObject}>
      <p>Theme: {cssVariables["--theme"]}</p>
    </div>
  );
}

Deep dependency tracking: `useVersion`

The useVersion hook provides deep dependency comparison through deep equality checking, making it ideal for complex state management scenarios. It allows you to track changes in deeply nested objects and arrays, providing both deep equality checking and version tracking for React hooks. It's the foundational hook used internally by useAsync and useSync, but can also be used directly when you want to build custom hooks with deep dependency checking using native React hooks like useMemo or useEffect.

Key Features:

Deep equality checking: Performs deep comparison of complex objects, arrays, and nested structures
Version tracking: Returns an incrementing version number that changes only when dependencies actually change
Performance optimized: Avoids unnecessary re-computations by detecting true changes
Circular reference support: Safely handles objects with circular references
Type safety: Full TypeScript support with proper type inference

Basic Usage:

import { createStore, useVersion } from "@ibnlanre/portal";
import { useEffect } from "react";

const settingsStore = createStore({
  theme: "light",
  preferences: {
    language: "en",
    notifications: { email: true, push: false },
  },
  useWatchPreferences() {
    const preferences = settingsStore.preferences.$get();
    const version = useVersion(preferences);

    useEffect(() => {
      console.log("Preferences changed:", preferences);
      // Sync preferences to external service
      syncPreferencesToServer(preferences);
    }, [version]);

    return preferences;
  },
});

The useVersion hook is particularly useful when you want deep dependency tracking for custom hooks, or when native React hooks (useMemo, useEffect, useCallback) need to respond to changes in complex objects or arrays.

Tip: Rather than using useEffect to sync the store state to an external service, consider using $act for more efficient updates. This allows you to subscribe to changes in the store and react accordingly, while also providing a way to unsubscribe when no longer needed.

Context-based stores: `createContextStore`

The createContextStore function enables efficient global store management through React Context. It provides a powerful pattern for creating provider-based stores that can be initialized with external data and shared across component trees.

Key Features:

Provider-based: Creates React Context providers for store sharing
Dynamic initialization: Initialize stores with props or external data
Type safety: Full TypeScript support with proper type inference
Efficient updates: Only re-renders components that use the specific store parts
Nested providers: Support for multiple independent or nested providers

Basic Usage:

import { combine, createStore, createContextStore } from "@ibnlanre/portal";

// Define the context type
type AppContext = {
  userId: string;
  theme: "light" | "dark";
  locale: string;
};

// Create the context scope
const [AppProvider, useAppStore] = createContextStore((context: AppContext) => {
  const initialState = {
    user: {
      id: context.userId,
      preferences: {
        theme: context.theme,
        locale: context.locale,
      },
    },
  };

  const actions = {
    toggleTheme: () => {
      store.user.preferences.theme.$set((previousTheme) => {
        return previousTheme === "light" ? "dark" : "light";
      });
    },
    updateTheme: (newTheme: "light" | "dark") => {
      store.user.preferences.theme.$set(newTheme);
    },
    updateLocale: (newLocale: string) => {
      store.user.preferences.locale.$set(newLocale);
    },
  };

  const store = createStore(combine(initialState, actions));
  return store;
});

Using the context-based store in a React application:

function App() {
  const appContext: AppContext = {
    userId: "user-123",
    theme: "light",
    locale: "en",
  };

  return (
    <AppProvider value={appContext}>
      <UserProfile />
      <Settings />
    </AppProvider>
  );
}

function UserProfile() {
  const store = useAppStore();

  const [userId] = store.user.id.$use();
  const [theme] = store.user.preferences.theme.$use();

  return (
    <div className={`profile theme-${theme}`}>
      <h1>User ID: {userId}</h1>
    </div>
  );
}

function Settings() {
  const store = useAppStore();
  const [theme] = store.user.preferences.theme.$use();

  return (
    <div>
      <button onClick={store.toggleTheme}>
        Toggle Theme (Current: {theme})
      </button>
    </div>
  );
}

Combine stores and actions: `combine()`

The combine() utility performs a deep merge between objects and now supports multiple sources for complex merging scenarios. It's useful for unifying your initial state and actions into one cohesive structure before passing it into createStore.

Unlike shallow merging (such as Object.assign or object spread), combine():

Recursively merges nested objects
Preserves store instances within deeply nested structures
Handles circular references safely
Supports multiple sources with later sources taking precedence
Enhanced type definitions for better TypeScript experience

Syntax:

// Single source merge
combine<Target extends Dictionary, Source>(target: Target, source: Source): Merge<Target, Source>

// Multiple sources merge
combine<Target extends Dictionary, Sources extends Dictionary[]>(target: Target, sources: Sources): Combine<Target, Sources>

target: Base state or object.
source: Object containing actions or additional properties to merge.
sources: Array of objects to merge in sequence, with later sources taking precedence.
Returns: A new, deeply merged object with references preserved.

Single Source Example:

import { createStore, combine } from "@ibnlanre/portal";

// Define the initial state
const initialState = {
  isLoggedIn: false,
  profile: {
    email: "[email protected]",
    name: "Alex",
  },
};

// Define actions separately
const actions = {
  login(email: string) {
    userStore.$set({
      profile: { email },
      isLoggedIn: true,
    });
  },
  logout() {
    userStore.$set({
      isLoggedIn: false,
      profile: { email: "", name: "" },
    });
  },
  updateName(newName: string) {
    userStore.profile.name.$set(newName);
  },
};

// Combine initial state and actions into a single object
export const userStore = createStore(combine(initialState, actions));

Multiple Sources Example:

import { createStore, combine } from "@ibnlanre/portal";

// Base configuration
const baseConfig = {
  api: {
    baseUrl: "https://api.example.com",
    timeout: 5000,
  },
  ui: {
    theme: "light",
    language: "en",
  },
};

// Environment-specific overrides
const developmentConfig = {
  api: {
    baseUrl: "https://dev-api.example.com",
    debug: true,
  },
  ui: {
    showDebugInfo: true,
  },
};

// User preferences
const userPreferences = {
  ui: {
    theme: "dark",
    fontSize: 16,
  },
  notifications: {
    email: true,
    push: false,
  },
};

// Combine all sources - later sources override earlier ones
const appConfig = combine(baseConfig, [developmentConfig, userPreferences]);

// Result will be:
// {
//   api: {
//     baseUrl: "https://dev-api.example.com", // from developmentConfig
//     timeout: 5000,                          // from baseConfig
//     debug: true                             // from developmentConfig
//   },
//   ui: {
//     theme: "dark",                          // from userPreferences
//     language: "en",                         // from baseConfig
//     showDebugInfo: true,                    // from developmentConfig
//     fontSize: 16                            // from userPreferences
//   },
//   notifications: {                          // from userPreferences
//     email: true,
//     push: false
//   }
// }

const configStore = createStore(appConfig);

Initialize state asynchronously

You can initialize a store with state fetched asynchronously by passing an async function (that returns a Promise) to createStore. The store will initially be empty (or hold the unresolved Promise object itself, depending on internal handling) until the Promise resolves.

Important Considerations:

The store's methods ($get, $set, $act, $use) will operate on the unresolved Promise or an initial empty state until resolution.
If the Promise resolves to an object, this object is treated as a single (primitive-like) value within the store. To achieve a nested structure from async data, initialize the store with a placeholder structure (or null) and then update it using $set once the data is fetched.
For complex or relational data, consider normalizing the data shape or using normalizeObject before store initialization.

Example:

import { createStore } from "@ibnlanre/portal";

interface UserData {
  id: number;
  name: string;
  email: string;
}

async function fetchInitialData(): Promise<UserData> {
  // Simulate API call
  return new Promise((resolve) =>
    setTimeout(
      () => resolve({ id: 1, name: "Lyn", email: "[email protected]" }),
      500
    )
  );
}

const userStore = await createStore(fetchInitialData());
// At this point, the promise has resolved, and the store is initialized.
const userData = userStore.$get();
console.log(userData); // { id: 1, name: "Lyn", email: "[email protected]" }

// userData is a single object. userStore.id does not exist as a sub-store.
// To update, you'd set the whole object:
userStore.$set({ id: 2, name: "Alex", email: "[email protected]" });

If you need a nested store structure from asynchronously loaded data, initialize the store with a placeholder structure (or null) and then update it using $set once the data is fetched. This allows the composite store structure to be established correctly.

import { createStore } from "@ibnlanre/portal";

interface AppData {
  user: { name: string; role: string } | null;
  settings: { theme: string } | null;
  loading: boolean;
}

const appDataStore = createStore<AppData>({
  user: null,
  settings: null,
  loading: true,
});

async function loadAppData() {
  try {
    // const fetchedData = await fetchActualDataFromAPI();
    const fetchedData = {
      // Example fetched data
      user: { name: "Sam", role: "admin" },
      settings: { theme: "dark" },
    };
    appDataStore.$set({ ...fetchedData, loading: false });

    // Now appDataStore.user.name.$get() would work.
    console.log(appDataStore.user.name.$get()); // "Sam"
  } catch (error) {
    console.error("Failed to load app data:", error);
    appDataStore.$set({ user: null, settings: null, loading: false }); // Handle error state
  }
}

loadAppData();

Handle circular references

@ibnlanre/portal handles objects with circular references safely during store creation and operations. This is particularly useful for complex data structures, such as graphs or when working with certain browser objects (after normalization).

Example:

import { createStore } from "@ibnlanre/portal";

// Define a type for clarity
interface Node {
  name: string;
  connections: Node[];
  metadata?: { type: string };
}

const nodeA: Node = {
  name: "A",
  connections: [],
  metadata: { type: "root" },
};
const nodeB: Node = {
  name: "B",
  connections: [],
  metadata: { type: "leaf" },
};

nodeA.connections.push(nodeB); // nodeA points to nodeB
nodeB.connections.push(nodeA); // nodeB points back to nodeA (circular reference)

const graphStore = createStore({
  nodes: [nodeA, nodeB], // 'nodes' is an array of Node objects
  selectedNode: nodeA, // 'selectedNode' is a Node object
});

// Accessing data:
// 1. For 'selectedNode' (a direct object property, so it and its properties are stores)
console.log(graphStore.selectedNode.name.$get()); // "A"

if (graphStore.selectedNode.metadata) {
  // Check if metadata exists
  console.log(graphStore.selectedNode.metadata.type.$get()); // "root"
}

// 2. For 'nodes' (an array property; elements are not individual stores)
const currentNodes = graphStore.nodes.$get(); // Get the array value

// Access properties of objects within the 'currentNodes' array
console.log(currentNodes[0].name); // "A" (Accessing nodeA.name directly)
console.log(currentNodes[0].connections[0].name); // "B" (Accessing nodeA.connections[0].name which is nodeB.name)

// Demonstrating the circular reference is preserved:
console.log(currentNodes[0].connections[0].connections[0].name); // "A" (nodeA -> nodeB -> nodeA)

// Updates also work correctly:
// Update via 'selectedNode' store
graphStore.selectedNode.name.$set("Node Alpha");
console.log(graphStore.selectedNode.name.$get()); // "Node Alpha"

// The original nodeA object (referenced by selectedNode and within the nodes array) is updated
console.log(nodeA.name); // "Node Alpha"

// Verify in the array retrieved from the store
const updatedNodes = graphStore.nodes.$get();
console.log(updatedNodes[0].name); // "Node Alpha"

// If you were to update an element within the 'nodes' array, you'd do it like this:
graphStore.nodes.$set((prevNodes) => {
  const newNodes = [...prevNodes];

  // Example: Change name of the second node (nodeB)
  if (newNodes[1]) {
    newNodes[1] = { ...newNodes[1], name: "Node Beta" };
  }

  return newNodes;
});

// Assuming nodeB was correctly updated in the array:
const finalNodes = graphStore.nodes.$get();

if (finalNodes[1]) {
  console.log(finalNodes[1].name); // Should be "Node Beta"
}

// And the original nodeB object is also updated if its reference was maintained
console.log(nodeB.name); // "Node Beta"

Warning: Circular references are supported, but be mindful of performance with very large or deeply nested graphs.

Handle arrays in stores

When your store's state includes arrays, @ibnlanre/portal treats them in a specific way:

Arrays as store properties: If an array is a direct property of your initial state object (e.g., items: [1, 2, 3] in createStore({ items: [...] })), then store.items becomes a store instance that manages this array. You can use $get(), $set(), and $act() on store.items to interact with the entire array.
```
const store = createStore({ tags: ["typescript", "state-management"] });
const currentTags = store.tags.$get(); // ['typescript', 'state-management']
store.tags.$set(["javascript", "react"]); // Replaces the array
```

Elements within arrays are not individual stores: Objects or other values inside an array are treated as plain data. They are not automatically wrapped as individual store instances. This means you cannot call store methods like $get() or $set() directly on an array element, even if that element is an object.

const store = createStore({
  users: [
    { id: 1, name: "Alice" },
    { id: 2, name: "Bob" },
  ],
});

// Correct: Get the array, then access elements
const usersArray = store.users.$get();
const firstUserName = usersArray[0].name; // "Alice"

// Incorrect: Attempting to treat an array element as a store
const firstUserStore = store.users[0]; // This is not how to access it
const name = store.users[0].name.$get(); // This will cause an error

Updating arrays:

To replace the entire array, use $set() on the array's store property:

const listStore = createStore({ items: [1, 2, 3] });
listStore.items.$set([4, 5, 6]);
console.log(listStore.items.$get()); // Output: [4, 5, 6]

To modify the array (e.g., add, remove, or update elements), use a functional update with $set() on the array's store property. This ensures immutability by creating a new array.

const userListStore = createStore({
  users: [{ id: 1, name: "Alex", details: { age: 30 } }],
});

// Add a new user
userListStore.users.$set((currentUsers) => [
  ...currentUsers,
  { id: 2, name: "Jordan", details: { age: 25 } },
]);

// Update an existing user's name
userListStore.users.$set((currentUsers) =>
  currentUsers.map((user) =>
    user.id === 1 ? { ...user, name: "Alexandra" } : user
  )
);
// To update a nested property within an object in an array:
userListStore.users.$set((currentUsers) =>
  currentUsers.map((user) =>
    user.id === 1
      ? { ...user, details: { ...user.details, age: 31 } }
      : user
  )
);

Arrays of primitive values: These are handled straightforwardly. The array itself is the store property.

const numberListStore = createStore({ ids: [101, 102, 103] });
numberListStore.ids.$set((prevIds) => [...prevIds, 104]);

This behavior ensures that arrays are managed predictably as collections, while direct object properties of a store are augmented for more granular control. If you require each item in a collection to have full store capabilities, consider structuring your state as an object mapping IDs to individual stores, rather than an array of items. For example:

const itemStores = createStore({
  item_1: { name: "Item A", stock: 10 },
  item_2: { name: "Item B", stock: 5 },
});
// Now itemStores.item_1 is a store, itemStores.item_1.name is a store, etc.

Normalize objects: `normalizeObject()`

The normalizeObject() function converts interface-typed objects (like window, DOM elements, or complex API responses that might not be plain JavaScript objects) into dictionary types (Record<PropertyKey, unknown>) compatible with composite stores. This is important when an object's structure includes methods, symbols, or other non-serializable parts that shouldn't be part of the reactive state, or when TypeScript's type system for interfaces doesn't align with the expected structure for a composite store.

normalizeObject helps by:

Converting interface types to store-compatible dictionary types.
Safely handling circular references within the object during normalization.
Filtering out non-data properties like functions and Symbols.
Only preserving properties with string or number keys (symbol keys are excluded).
Preserving the accessible data structure of the original object.

Important: The normalized object will only contain properties with string or number keys. Symbol keys are excluded during normalization.

Syntax:

normalizeObject<T extends object>(obj: T): Record<PropertyKey, unknown> // Simplified, actual return might be more specific

obj: The object to normalize.
Returns: A new object that is a "plain" JavaScript object representation of obj, suitable for createStore.

Examples:

Normalizing the browser's window object:

import { createStore, normalizeObject } from "@ibnlanre/portal";

// The 'window' object is complex and has an interface type.
// Normalizing it makes it suitable for a composite store.
const normalizedWindow = normalizeObject(window);
const browserInfoStore = createStore(normalizedWindow);

// Now you can access properties like browserInfoStore.navigator.userAgent.$get()
// Note: Functions on window (like alert) would typically be excluded by normalization.
console.log(browserInfoStore.location.href.$get());

// This might work if 'document' is data-like
console.log(browserInfoStore.document.title.$get());

Normalizing a custom interface with methods and symbols:

import { createStore, normalizeObject } from "@ibnlanre/portal";

interface UserProfileAPI {
  id: number;
  getFullName(): string; // A method
  lastLogin: Date;
  internalConfig: symbol; // A symbol
  data: { value: string };
}

const apiResponse: UserProfileAPI = {
  id: 123,
  getFullName: () => "Alex Doe",
  lastLogin: new Date(),
  internalConfig: Symbol("config"),
  data: { value: "test" },
};

const normalizedUserProfile = normalizeObject(apiResponse);
/*
  normalizedUserProfile will be:
  {
    id: 123,
    lastLogin: // Date object (preserved as it's data-like)
    data: { value: "test" }
  }
  // The getFullName method and internalConfig symbol are removed by normalization,
  // as functions and symbol keys are filtered out.
*/

const userProfileStore = createStore(normalizedUserProfile);
console.log(userProfileStore.id.$get()); // 123
console.log(userProfileStore.data.value.$get()); // "test"

// userProfileStore.getFullName is undefined (method was stripped)
// userProfileStore.internalConfig is undefined (symbol key was excluded)

Infer state types: `InferType`

The InferType utility type allows you to extract TypeScript types from your Portal stores. This is especially useful when you need to work with the underlying state type in other parts of your application, such as API calls, form validation, or when passing state to other components.

Syntax:

InferType<Store, Path?>;

Parameters:

Store: The store from which to infer the type (must extend PrimitiveStore<any>)
Path (optional): A path within the store's state to extract a specific nested type

Returns: The TypeScript type of the store's state, or the type at the specified path

Examples:

Infer the complete state type:

import { createStore, InferType } from "@ibnlanre/portal";

const userStore = createStore({
  age: 30,
  name: "Alice",
  preferences: {
    notifications: true,
    theme: "dark",
  },
});

// Infer t

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

@ibnlanre/portal

Table of contents

Features

Get started

Prerequisites

Install the library

Using a package manager

Using a CDN

Understand core concepts

What is a store?

Store types: Primitive and Composite

Immutability and reactivity

⚠️ Important: Use Types, Not Interfaces

Configure your stores

Use the API: Reference and examples

Create stores: createStore()

Using createStore()

Using createPrimitiveStore()

Using createCompositeStore()

Create context stores: createContextStore()

Use store instance methods

$get()

$set()

$act()

$key()

$use() (React Hook)

Define actions: Functions in stores

Actions as hooks

Asynchronous effects: useAsync

Memoized computations: useSync

Deep dependency tracking: useVersion

Context-based stores: createContextStore

Combine stores and actions: combine()

Initialize state asynchronously

Handle circular references

Handle arrays in stores

Normalize objects: normalizeObject()

Infer state types: InferType

Create stores: `createStore()`

Using `createStore()`

Using `createPrimitiveStore()`

Using `createCompositeStore()`

Create context stores: `createContextStore()`

`$get()`

`$set()`

`$act()`

`$key()`

`$use()` (React Hook)

Asynchronous effects: `useAsync`

Memoized computations: `useSync`

Deep dependency tracking: `useVersion`

Context-based stores: `createContextStore`

Combine stores and actions: `combine()`

Normalize objects: `normalizeObject()`

Infer state types: `InferType`