Options
All
  • Public
  • Public/Protected
  • All
Menu

@xmtp/xmtp-js

Index

Classes

Interfaces

Type aliases

Variables

Functions

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.

Composite

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

Conversation

Conversation: ConversationV1 | ConversationV2

ListMessagesOptions

ListMessagesOptions: { checkAddresses?: boolean; direction?: messageApi.SortDirection; endTime?: Date; limit?: number; startTime?: Date }

Type declaration

  • Optional checkAddresses?: boolean
  • Optional direction?: messageApi.SortDirection
  • Optional endTime?: Date
  • Optional limit?: number
  • Optional startTime?: Date

Message

Message: MessageV1 | MessageV2

PrivateKeyBundle

PrivateKeyBundle: PrivateKeyBundleV1 | PrivateKeyBundleV2

SendOptions

SendOptions: { compression?: xmtpEnvelope.Compression; contentFallback?: string; contentType?: ContentTypeId; timestamp?: Date }

Type declaration

  • Optional compression?: xmtpEnvelope.Compression
  • Optional contentFallback?: string
  • Optional contentType?: ContentTypeId
  • Optional timestamp?: Date

Variables

Compression

Compression: typeof Compression

ContentTypeComposite

ContentTypeComposite: ContentTypeId = ...

ContentTypeFallback

ContentTypeFallback: ContentTypeId = ...

ContentTypeText

ContentTypeText: ContentTypeId = ...

SortDirection

SortDirection: typeof SortDirection

Functions

dateToNs

  • dateToNs(date: Date): Long

Const fromNanoString

  • fromNanoString(s: undefined | string): undefined | Date

  • Parameters

    • s: undefined | string

    Returns undefined | Date

nsToDate

  • nsToDate(ns: Long): Date

Const toNanoString

  • toNanoString(d: undefined | Date): undefined | string

  • Parameters

    • d: undefined | Date

    Returns undefined | string

Generated using TypeDoc