Docs mismatch: useUIStream API differs between docs site and npm package

[grgelsec]

For step 4 in the quick start, the docs show the incorrect destructure for useUIStream.

Current docs:

const { tree, isLoading, generate } = useUIStream({
    endpoint: '/api/generate',
  });

here

The npm README and actual package types use:

const { tree, isStreaming, error, send, clear } = useUIStream({
     api: '/api/generate',
  });

[ctate]

Thanks for reporting this. The quick start page was already updated before this issue was filed, and we've now fixed the remaining mismatches on the API reference and streaming docs pages as well.

The current API is:

const {
  spec,         // Spec | null
  isStreaming,  // boolean
  error,        // Error | null
  send,         // (prompt: string, context?: Record<string, unknown>) => Promise<void>
  clear,        // () => void
} = useUIStream({
  api: '/api/generate',
  onComplete: (spec) => {},
  onError: (error) => {},
});

Notable changes since the original report:

• Return value uses spec instead of tree
• endpoint is now api
• isLoading / generate are now isStreaming / send
• Docs previously referenced abort, onChunk, and onFinish which have been corrected to clear, onComplete, and onError

All docs pages should now be in sync with the implementation.

[grgelsec]

Of course! The "Show all" additions to the docs are clean, good luck with everything!