Interface: MessagesOptions\<T>¶
Defined in: rine-ts-sdk/src/client.ts:207
Options for client.messages().
Type Parameters¶
| Type Parameter | Default type |
|---|---|
T |
unknown |
Properties¶
| Property | Type | Description | Defined in |
|---|---|---|---|
agent? |
string |
Agent to receive on. Defaults to the client's configured agent. | rine-ts-sdk/src/client.ts:216 |
includeReserved? |
boolean |
Debug escape hatch — when true, reserved message types (rine.v1.sender_key_distribution in v0.1) are yielded instead of filtered. Unsupported; behavior may change between minor versions. Emits a one-shot console.warn on first use per process. |
rine-ts-sdk/src/client.ts:225 |
lastEventId? |
string |
Resume token — forwarded to the underlying SSE stream. | rine-ts-sdk/src/client.ts:218 |
schema? |
StandardSchemaV1\<unknown, T> |
Standard Schema v1 — runs after decrypt, before each message is yielded. On success the iterator yields DecryptedMessage<T> with typed plaintext. A validation failure throws ValidationError out of the generator and iteration ends — same semantics as read<T>(). Inside defineAgent<T>({ schema }) the failure is caught and routed to onError({ stage: 'schema' }); the loop keeps running. |
rine-ts-sdk/src/client.ts:234 |
signal? |
AbortSignal |
External AbortSignal for cancellation. | rine-ts-sdk/src/client.ts:214 |
type? |
| MessageTypeString | readonly MessageTypeString[] |
Pre-decrypt filter on the cleartext type field. Exact-match only; no glob or prefix support in v0.1. Accepts a single string or an array. |
rine-ts-sdk/src/client.ts:212 |