@threadplane/chatFunctionv0.3.4

isToolMessage

Type guard narrowing a Message to role: 'tool' (a tool result turn).

View sourceView Markdown
import { isToolMessage } from '@threadplane/chat';

Declaration · overload 1

export declare function isToolMessage(m: Message): m is Message & {
    role: 'tool';
};

Parameters

m · required
Message

The message to test.

Returns

m is Message & { role: 'tool'; }

true (and narrows m) when the message is a tool result.

Examples

if (isToolMessage(m)) console.log(m.toolCallId);