@hashbrownai/angular.ChatResourceRef: Hashbrown API

Represents the reactive chat resource, including current messages and control methods.

API

interface ChatResourceRef<Tools extends Chat.AnyTool, State = unknown> extends Resource<Chat.Message<string, Tools>[]>  {

generatingError:  Signal <
   Error  | undefined
>;

isGenerating:  Signal <boolean>;

isLoading:  Signal <boolean>;

isReceiving:  Signal <boolean>;

readonly isResuming: Signal<boolean>;

isRunningToolCalls:  Signal <boolean>;

isSending:  Signal <boolean>;

lastAssistantMessage:  Signal <
   Chat.AssistantMessage <string, Tools> | undefined
>;

readonly pendingInterrupts: Signal<PendingInterruptBatch | undefined>;

reload: () => boolean;

resume(options: ResumeOptions): void;

sendingError:  Signal <
   Error  | undefined
>;

sendMessage: (message: Chat.UserMessage) => void;

setMessages: (messages: Chat.Message<string, Tools>[]) => void;

setState(state: State): void;

readonly state: Signal<State | undefined>;

stop: (clearStreamingMessage?: boolean) => void;

@typeTools

Chat.AnyTool

@typeState

Error emitted during generation events.

Indicates whether the chat is currently generating assistant output.

Aggregate loading flag across transport, generation, and tool calls.

Indicates whether the chat is currently receiving tokens.

Whether the resumed interaction is still running.

Indicates whether the chat is running tool calls.

Indicates whether the chat is currently sending a user message.

The last assistant message for the chat.

The complete pending interrupt batch, including while claimed.

Remove the last assistant response and re-send the previous user message. Returns true if a reload was performed.

Transport/request error before generation events arrive.

Send a new user message to the chat.

Replace the current chat message history.

The currently visible shared agent state.

Stops any currently-streaming message.