Skip to content

Update llms-full.txt #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 17, 2025
Merged

Update llms-full.txt #378

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 23 additions & 7 deletions llms/llms-full.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# XMTP Full Documentation

Generated at 08:42 PM UTC / September 11, 2025
Generated at 08:06 PM UTC / September 16, 2025

## Instructions for AI Tools

Expand Down Expand Up @@ -928,6 +928,8 @@ const client = await Client.create(
// client options
{
dbEncryptionKey,
// Optional: Use a function to dynamically set the database path based on inbox ID
// dbPath: (inboxId) => `./agent-databases/xmtp-${inboxId}.db3`,
},
);
```
Expand Down Expand Up @@ -971,7 +973,7 @@ type ClientOptions = {
/**
* Path to the local DB
*
* There are 3 value types that can be used to specify the database path:
* There are 4 value types that can be used to specify the database path:
*
* - `undefined` (or excluded from the client options)
* The database will be created in the current working directory and is based on
Expand All @@ -984,8 +986,12 @@ type ClientOptions = {
* - `string`
* The given path will be used to create the database.
* Example: `./my-db.db3`
*
* - `function`
* A callback function that receives the inbox ID and returns a string path.
* Example: `(inboxId) => string`
*/
dbPath?: string | null;
dbPath?: string | null | ((inboxId: string) => string);
/**
* Encryption key for the local DB
*/
Expand Down Expand Up @@ -5725,6 +5731,8 @@ const client = await Client.create(
// client options
{
dbEncryptionKey,
// Optional: Use a function to dynamically set the database path based on inbox ID
// dbPath: (inboxId) => `./databases/xmtp-${inboxId}.db3`,
},
);
```
Expand Down Expand Up @@ -5812,7 +5820,7 @@ type ClientOptions = {
/**
* Path to the local DB
*
* There are 3 value types that can be used to specify the database path:
* There are 4 value types that can be used to specify the database path:
*
* - `undefined` (or excluded from the client options)
* The database will be created in the current working directory and is based on
Expand All @@ -5825,8 +5833,12 @@ type ClientOptions = {
* - `string`
* The given path will be used to create the database.
* Example: `./my-db.db3`
*
* - `function`
* A callback function that receives the inbox ID and returns a string path.
* Example: `(inboxId) => string`
*/
dbPath?: string | null;
dbPath?: string | null | ((inboxId: string) => string);
/**
* Encryption key for the local DB
*/
Expand Down Expand Up @@ -5897,7 +5909,7 @@ type ClientOptions = {
/**
* Path to the local DB
*
* There are 3 value types that can be used to specify the database path:
* There are 4 value types that can be used to specify the database path:
*
* - `undefined` (or excluded from the client options)
* The database will be created in the current working directory and is based on
Expand All @@ -5910,8 +5922,12 @@ type ClientOptions = {
* - `string`
* The given path will be used to create the database.
* Example: `./my-db.db3`
*
* - `function`
* A callback function that receives the inbox ID and returns a string path.
* Example: `(inboxId) => string`
*/
dbPath?: string | null;
dbPath?: string | null | ((inboxId: string) => string);
/**
* Encryption key for the local DB
*/
Expand Down