Class BaseMessageClient

constructor

• new BaseMessageClient(apiServer?: string, wsServer?: string): BaseMessageClient

  Parameters

  • apiServer: string = DEFAULT_API_V2
  • wsServer: string = DEFAULT_API_WS_V2

  Returns BaseMessageClient

apiServer

wsServer

get

• get<T extends MessageType | "any" = "any", Content = any>(
      configuration: GetMessageConfiguration,
  ): Promise<PublishedMessage<MessageTypeMap<Content>[T]>>

  Retrieves a specific Message with query params.

  Type Parameters

  • T extends MessageType | "any" = "any"
  • Content = any

  Parameters

  • configuration: GetMessageConfiguration

    The message params to make the query.

  Returns Promise<PublishedMessage<MessageTypeMap<Content>[T]>>

getAll

• getAll(configuration: GetMessagesConfiguration): Promise<MessagesQueryResponse>

  Retrieves Messages with query params.

  Parameters

  • configuration: GetMessagesConfiguration

    The message params to make the query.

  Returns Promise<MessagesQueryResponse>

getAsyncIterator

• getAsyncIterator(
      configuration: Omit<GetMessagesCursorConfiguration, "cursor">,
  ): AsyncGenerator<PublishedMessage<MessageContent>>

  Returns an async iterator over all messages matching the given filters. Handles cursor-based pagination automatically.

  Parameters

  • configuration: Omit<GetMessagesCursorConfiguration, "cursor">

    The message filters (same as getAll, minus page).

  Returns AsyncGenerator<PublishedMessage<MessageContent>>

getContent

• getContent<Content = any>(item_hash: string): Promise<Content>

  Retrieves only the content of a message, without the surrounding message envelope.

  Type Parameters

  • Content = any

  Parameters

  • item_hash: string

    The hash of the message to query.

  Returns Promise<Content>

getCursor

• getCursor(
      configuration: GetMessagesCursorConfiguration,
  ): Promise<CursorMessagesResponse>

  Retrieves Messages using cursor-based pagination. Pass an empty cursor (or omit it) to start from the beginning.

  Parameters

  • configuration: GetMessagesCursorConfiguration

    The message params to make the query.

  Returns Promise<CursorMessagesResponse>

getError

• getError(item_hash: string): Promise<null | MessageError>

  Retrieves the error of a rejected message

  Parameters

  • item_hash: string

    The hash of the rejected message

  Returns Promise<null | MessageError>

getMessagesSocket

• getMessagesSocket(
      params: Omit<GetMessagesSocketConfiguration, "apiServer">,
  ): Promise<AlephSocket>

  Parameters

  • params: Omit<GetMessagesSocketConfiguration, "apiServer">

  Returns Promise<AlephSocket>

getStatus

• getStatus(item_hash: string): Promise<MessageStatusInfo>

  Retrieves the processing status of a message (pending, processed, rejected or forgotten).

  Lighter than get: it returns only the status and reception time, without the message content.

  Unlike get and getError, a forgotten message is returned as data with status "forgotten" rather than throwing ForgottenMessageError. Callers must inspect the returned status field; no exception is thrown for forgotten, rejected or pending states. Only a missing hash (404) throws (MessageNotFoundError).

  Parameters

  • item_hash: string

    The hash of the message to query.

  Returns Promise<MessageStatusInfo>