Class MessageStoreLevel

constructor

• new MessageStoreLevel(config?): MessageStoreLevel

• Parameters

  • config: MessageStoreLevelConfig = {}

  Returns MessageStoreLevel

blockstore

config

index

clear

• clear(): Promise<void>

• deletes everything in the underlying blockstore and indices.

  Returns Promise<void>

close

• close(): Promise<void>

• closes the connection to the underlying store

  Returns Promise<void>

delete

• delete(tenant, cidString, options?): Promise<void>

• Deletes the message associated with the id provided.

  Parameters

  • tenant: string
  • cidString: string
  • Optional options: MessageStoreOptions

  Returns Promise<void>

get

• get(tenant, cidString, options?): Promise<undefined | GenericMessage>

• Fetches a single message by cid from the underlying store. Returns undefined no message was found.

  Parameters

  • tenant: string
  • cidString: string
  • Optional options: MessageStoreOptions

  Returns Promise<undefined | GenericMessage>

open

• open(): Promise<void>

• opens a connection to the underlying store

  Returns Promise<void>

put

• put(tenant, message, indexes, options?): Promise<void>

• adds a message to the underlying store. Uses the message's cid as the key

  Parameters

  • tenant: string
  • message: GenericMessage
  • indexes: KeyValues

    indexes (key-value pairs) to be included as part of this put operation
  • Optional options: MessageStoreOptions

  Returns Promise<void>

query

• query(tenant, filters, messageSort?, pagination?, options?): Promise<{
      cursor?: PaginationCursor;
      messages: GenericMessage[];
  }>

• Queries the underlying store for messages that matches the provided filters. Supplying multiple filters establishes an OR condition between the filters.

  Parameters

  • tenant: string
  • filters: Filter[]
  • Optional messageSort: MessageSort
  • Optional pagination: Pagination
  • Optional options: MessageStoreOptions

  Returns Promise<{
      cursor?: PaginationCursor;
      messages: GenericMessage[];
  }>

Static buildQueryOptions

• buildQueryOptions(messageSort?, pagination?): QueryOptions

• Builds the IndexLevel QueryOptions object given MessageStore sort and pagination parameters.

  Parameters

  • messageSort: MessageSort = {}
  • pagination: Pagination = {}

  Returns QueryOptions