Skip to Content

Interface DomainList

What MemoryOperations.listDomains returns.

Calling it is also how a client learns the caps it enforces locally, which is why Memco.connect calls it while verifying the connection. Until it has answered, every request is checked against structural rules only and the service decides the rest.

limits is null when the service reported none, and that means "check nothing" rather than "every cap is zero" — reading an absent message as zeros would reject every call before it was sent. A service that predates the field sends nothing at all, so this is the state to expect from an older one, not a malfunction.

deprecated does not say whether it is the API version or this SDK build that is superseded, and is not meant to: only deprecationMessage carries the remedy, so relay the message rather than inferring a cause from the flag. The SDK raises a process warning from the message rather than from the flag, once per distinct message, tagged with DEPRECATION_WARNING_NAME.

const { domains, limits } = await client.memory.listDomains()
for (const domain of domains) {
  console.log(domain.slug, domain.summary)
}
if (limits === null) {
  console.log('no caps reported; the service judges each call itself')
}
interface DomainList {
    domains: readonly DomainEntry[];
    instructions: Instructions;
    limits: Limits | null;
    deprecated: boolean;
    deprecationMessage: string;
    sunsetDate: string | null;
    serverCommit: string;
}
Index
domains instructions limits deprecated deprecationMessage sunsetDate serverCommit
domains: readonly DomainEntry[]

The domains this credential may name.

instructions: Instructions

What the service asks the caller to do with them.

limits: Limits | null

The bounds to enforce, or null when the service reported none.

deprecated: boolean

Whether the service considers this client out of date.

deprecationMessage: string

The service's own wording of the notice. Empty when there is none.

sunsetDate: string | null

When the deprecated thing stops working, as YYYY-MM-DD.

serverCommit: string

The server commit this response came from.

Quickstart