Class PostMessageClient

constructor

• new PostMessageClient(apiServer?: string): PostMessageClient

  Parameters

  • apiServer: string = DEFAULT_API_V2

  Returns PostMessageClient

apiServer

get

• get<T = any>(config: PostGetConfiguration): Promise<PostResponse<T>>

  Retrieves a post message from the Aleph network.

  Type Parameters

  • T = any

  Parameters

  • config: PostGetConfiguration

  Returns Promise<PostResponse<T>>

getAll

• getAll<T = any>(
      __namedParameters: PostGetConfiguration,
  ): Promise<PostQueryResponse<T>>

  Queries the Aleph network for post messages.

  Type Parameters

  • T = any

  Parameters

  • __namedParameters: PostGetConfiguration

  Returns Promise<PostQueryResponse<T>>

getAsyncIterator

• getAsyncIterator<T = any>(
      configuration: Omit<PostGetCursorConfiguration, "cursor">,
  ): AsyncGenerator<PostResponse<T>>

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

  Type Parameters

  • T = any

  Parameters

  • configuration: Omit<PostGetCursorConfiguration, "cursor">

  Returns AsyncGenerator<PostResponse<T>>

getCursor

• getCursor<T = any>(
      __namedParameters: PostGetCursorConfiguration,
  ): Promise<CursorPostsResponse<T>>

  Queries the Aleph network for post messages using cursor-based pagination. Pass an empty cursor (or omit it) to start from the beginning.

  Type Parameters

  • T = any

  Parameters

  • __namedParameters: PostGetCursorConfiguration

  Returns Promise<CursorPostsResponse<T>>

send

• send<T>(__namedParameters: PostPublishConfiguration<T>): Promise<PostMessage<T>>

  Publishes a post message to the Aleph network.

  Type Parameters

  • T

    The type of the content of the message.

  Parameters

  • __namedParameters: PostPublishConfiguration<T>

  Returns Promise<PostMessage<T>>

  The message that was published.

  Throws

  InvalidMessageError if the message is not compliant with the Aleph protocol.

  Throws

  BroadcastError if the message could not be broadcast for any other reason.