@stackend/api/like/likeActions.d.ts

JS bindings to api.stackend.com

import { LikeResult, LikeDataMap } from './index';
import { Thunk } from '../api';
import { LikesState } from './likeReducer';
/**
 * Like or remove a like from an object.
 *
 * Supply one of the parameters reference or obfuscatedReference.
 *
 * The new number of likes will be returned.
 */
export declare function like({ obfuscatedReference, reference, context }: {
    obfuscatedReference?: string;
    reference?: string;
    context?: string;
}): Thunk<Promise<LikeResult>>;
/**
 * Remove a like from an object.
 *
 * Supply one of the parameters reference or obfuscatedReference.
 *
 * The new number of likes will be returned.
 *
 */
export declare function removeLike({ obfuscatedReference, reference, context }: {
    obfuscatedReference?: string;
    reference?: string;
    context: string;
}): Thunk<Promise<LikeResult>>;
/**
 * Clear all likes in the redux store
 */
export declare function clearLikes(): Thunk<void>;
/**
 * Update a like in the redux store
 * @param obfuscatedReference
 * @param likes: number of likes
 * @param likedByCurrentUser
 */
export declare function updateLike(obfuscatedReference: string, likes: number | undefined, likedByCurrentUser: boolean | undefined): Thunk<void>;
/**
 * Update the redux store with received likes
 * @param likeDataMap
 */
export declare function receiveLikes(likeDataMap: LikeDataMap | undefined): Thunk<void>;
/**
 * Get the number of likes for an object
 * @param likes
 * @param obfuscatedReference
 */
export declare function getNumberOfLikes(likes: LikesState, obfuscatedReference: string): number;
/**
 * Check if an object is liked by the current user
 * @param likes
 * @param obfuscatedReference
 */
export declare function isLikedByCurrentUser(likes: LikesState, obfuscatedReference: string): boolean;
//# sourceMappingURL=likeActions.d.ts.map