Skip to content

Commit 577ef88

Browse files
authored
Merge pull request #581 from ai16z/new_docs
feat: add new pages
2 parents ac3188b + e010e77 commit 577ef88

File tree

127 files changed

+2288
-1052
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+2288
-1052
lines changed

docs/api/classes/AgentRuntime.md

+128-74
Large diffs are not rendered by default.

docs/api/classes/CacheManager.md

+117
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
[@ai16z/eliza v0.1.3](../index.md) / CacheManager
2+
3+
# Class: CacheManager\<CacheAdapter\>
4+
5+
## Type Parameters
6+
7+
**CacheAdapter** *extends* [`ICacheAdapter`](../interfaces/ICacheAdapter.md) = [`ICacheAdapter`](../interfaces/ICacheAdapter.md)
8+
9+
## Implements
10+
11+
- [`ICacheManager`](../interfaces/ICacheManager.md)
12+
13+
## Constructors
14+
15+
### new CacheManager()
16+
17+
> **new CacheManager**\<`CacheAdapter`\>(`adapter`): [`CacheManager`](CacheManager.md)\<`CacheAdapter`\>
18+
19+
#### Parameters
20+
21+
**adapter**: `CacheAdapter`
22+
23+
#### Returns
24+
25+
[`CacheManager`](CacheManager.md)\<`CacheAdapter`\>
26+
27+
#### Defined in
28+
29+
[packages/core/src/cache.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/cache.ts#L93)
30+
31+
## Properties
32+
33+
### adapter
34+
35+
> **adapter**: `CacheAdapter`
36+
37+
#### Defined in
38+
39+
[packages/core/src/cache.ts:91](https://github.com/ai16z/eliza/blob/main/packages/core/src/cache.ts#L91)
40+
41+
## Methods
42+
43+
### get()
44+
45+
> **get**\<`T`\>(`key`): `Promise`\<`T`\>
46+
47+
#### Type Parameters
48+
49+
**T** = `unknown`
50+
51+
#### Parameters
52+
53+
**key**: `string`
54+
55+
#### Returns
56+
57+
`Promise`\<`T`\>
58+
59+
#### Implementation of
60+
61+
[`ICacheManager`](../interfaces/ICacheManager.md).[`get`](../interfaces/ICacheManager.md#get)
62+
63+
#### Defined in
64+
65+
[packages/core/src/cache.ts:97](https://github.com/ai16z/eliza/blob/main/packages/core/src/cache.ts#L97)
66+
67+
***
68+
69+
### set()
70+
71+
> **set**\<`T`\>(`key`, `value`, `opts`?): `Promise`\<`void`\>
72+
73+
#### Type Parameters
74+
75+
**T**
76+
77+
#### Parameters
78+
79+
**key**: `string`
80+
81+
**value**: `T`
82+
83+
**opts?**: [`CacheOptions`](../type-aliases/CacheOptions.md)
84+
85+
#### Returns
86+
87+
`Promise`\<`void`\>
88+
89+
#### Implementation of
90+
91+
[`ICacheManager`](../interfaces/ICacheManager.md).[`set`](../interfaces/ICacheManager.md#set)
92+
93+
#### Defined in
94+
95+
[packages/core/src/cache.ts:116](https://github.com/ai16z/eliza/blob/main/packages/core/src/cache.ts#L116)
96+
97+
***
98+
99+
### delete()
100+
101+
> **delete**(`key`): `Promise`\<`void`\>
102+
103+
#### Parameters
104+
105+
**key**: `string`
106+
107+
#### Returns
108+
109+
`Promise`\<`void`\>
110+
111+
#### Implementation of
112+
113+
[`ICacheManager`](../interfaces/ICacheManager.md).[`delete`](../interfaces/ICacheManager.md#delete)
114+
115+
#### Defined in
116+
117+
[packages/core/src/cache.ts:123](https://github.com/ai16z/eliza/blob/main/packages/core/src/cache.ts#L123)

0 commit comments

Comments
 (0)