Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

CapabilityGetter.md

62 lines1.3 KB

1---
2id: CapabilityGetter
3title: CapabilityGetter
4---
5​
6# Interface: CapabilityGetter()\<TValue\>
7​
8Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:17](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L17)
9​
10Reads a capability value off a context. Overloaded so the flag narrows the return.
11​
12## Type Parameters
13​
14### TValue
15​
16`TValue`
17​
18## Call Signature
19​
20```ts
21CapabilityGetter(ctx): TValue;
22```
23​
24Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:18](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L18)
25​
26Reads a capability value off a context. Overloaded so the flag narrows the return.
27​
28### Parameters
29​
30#### ctx
31​
32[`CapabilityContext`](CapabilityContext.md)
33​
34### Returns
35​
36`TValue`
37​
38## Call Signature
39​
40```ts
41CapabilityGetter(ctx, opts): TValue | undefined;
42```
43​
44Defined in: [packages/ai/src/activities/chat/middleware/capabilities.ts:19](https://github.com/TanStack/ai/blob/main/packages/ai/src/activities/chat/middleware/capabilities.ts#L19)
45​
46Reads a capability value off a context. Overloaded so the flag narrows the return.
47​
48### Parameters
49​
50#### ctx
51​
52[`CapabilityContext`](CapabilityContext.md)
53​
54#### opts
55​
56##### optional
57​
58`true`
59​
60### Returns
61​
62`TValue` \| `undefined`