@solarpunkltd/comment-system/dist/types/reactions.d.ts

A library for writing and reading comments from the Swarm network.

import { FeedIndex, UploadResult } from '@ethersphere/bee-js';
import { Options } from './model/options.model';
import { MessageData, MessagesWithIndex } from './model';
/**
 * Writes a list of reactions to a feed index using the Bee API.
 *
 * @param reactions - An array of `Reaction` objects to be written to the feed.
 * @param index - (Optional) The feed index to which the reactions will be written. If not provided, the default index is used.
 * @param options The options to use for writing the reactions.
 * @throws PrivateKeyError if no privatekey is provided and it cannot be generated from the url.
 * @throws IdentifierError if no identifier is provided and it cannot be generated from the privatekey.
 * @throws StampError if no valid stamp is found.
 *
 * @returns An UploadResult object returned by the feed update or undefined in case of failure.
 */
export declare function writeReactionsToIndex(reactions: MessageData[], index?: FeedIndex, options?: Options): Promise<UploadResult | undefined>;
/**
 * Reads and array of reaction objects from a feed.
 *
 * @param index - (Optional) The feed index from which the reactions will be read. If not provided, a lookup is performed.
 * @param options The options to use for writing the reactions.
 * @throws {ReactionError} If the reaction data format is invalid.
 * @throws PrivateKeyError if no privatekey is provided and it cannot be generated from the url.
 * @throws IdentifierError if no identifier is provided and it cannot be generated from the privatekey.
 *
 * @returns A reactions array that was read from the feed or undefined in case of failure.
 */
export declare function readReactionsWithIndex(index?: FeedIndex, options?: Options): Promise<MessagesWithIndex>;
//# sourceMappingURL=reactions.d.ts.map