useObject

useObject<T>(options): UseObjectReturn<T>

Defined in: use-object.ts:49

useObject - React hook for streaming structured objects.

Provides state management for streaming JSON objects with partial updates as data arrives.

Type Parameters

T

T

Parameters

options

UseObjectOptions<T> = {}

Returns

UseObjectReturn<T>

Example

import { useObject } from 'ai.matey.react.core';

interface Recipe {
  name: string;
  ingredients: string[];
  instructions: string[];
}

function RecipeGenerator() {
  const { object, submit, isLoading } = useObject<Recipe>({
    api: '/api/generate-recipe',
  });

  return (
    <div>
      <button onClick={() => submit('Generate a pasta recipe')} disabled={isLoading}>
        Generate Recipe
      </button>
      {object && (
        <div>
          <h2>{object.name}</h2>
          <ul>{object.ingredients?.map((i, idx) => <li key={idx}>{i}</li>)}</ul>
        </div>
      )}
    </div>
  );
}