Skip to main content

Other types and variables

Type Aliases

ClientOptions

ClientOptions: NetworkOptions & KeyStoreOptions & ContentOptions

Aggregate type for client options. Optional properties are used when the default value is calculated on invocation, and are computed as needed by each function. All other defaults are specified in defaultOptions.

Defined in

Client.ts:97


Composite

Composite: { content: any ; type: ContentTypeId } | { parts: Composite[] }

Defined in

codecs/Composite.ts:24


ListMessagesOptions

ListMessagesOptions: Object

Type declaration

NameType
checkAddresses?boolean
endTime?Date
limit?number
startTime?Date

Defined in

Client.ts:46


SendOptions

SendOptions: Object

Type declaration

NameType
compression?xmtpEnvelope.Compression
contentFallback?string
contentType?ContentTypeId
timestamp?Date

Defined in

Client.ts:61

Variables

Compression

Compression: typeof Compression

Defined in

Client.ts:30


ContentTypeComposite

Const ContentTypeComposite: ContentTypeId

Defined in

codecs/Composite.ts:15


ContentTypeFallback

Const ContentTypeFallback: ContentTypeId

Defined in

MessageContent.ts:56


ContentTypeText

Const ContentTypeText: ContentTypeId

Defined in

codecs/Text.ts:6