@stackend/api/vote/index.d.ts

JS bindings to api.stackend.com

import { XcapJsonResult, Thunk, XcapOptionalParameters } from '../api';
import ReferenceIdAware from '../api/ReferenceIdAware';
import XcapObject from '../api/XcapObject';
import ReferenceGroupIdAware from '../api/ReferenceGroupIdAware';
import CreatedDateAware from '../api/CreatedDateAware';
import CreatorUserIdAware from '../api/CreatorUserIdAware';
/** VoteSummary is used for like and dislike in forum*/
export interface VoteSummary extends ReferenceIdAware<XcapObject>, ReferenceGroupIdAware {
    /** Average score */
    average: number;
    /** Vote value and the number of votes on that value 2 for like, 1 for dislike */
    nrOfVotesByScore: {
        [value: number]: number;
    };
    totalNrOfVotes: number;
    totalScore: number;
}
export interface Vote extends CreatedDateAware, CreatorUserIdAware, ReferenceGroupIdAware {
    id: number;
    score: number;
    refId: number;
    creatorIp: string;
}
export interface VoteResult extends XcapJsonResult {
    maxScore: number;
    minScore: number;
    minimumRequiredVotes: number;
    hasVoted: boolean;
    mayVote: boolean;
    hasEnoughVotes: boolean;
    average: number;
    averageAsInt: number;
    voteSummary: VoteSummary | null;
    vote: Vote | null;
}
/**
 * Cast a vote.
 */
export declare function vote({ referenceId, referenceGroupId, score, module }: {
    referenceId: number;
    referenceGroupId: number;
    score: number;
    module?: string;
} & XcapOptionalParameters): Thunk<Promise<VoteResult>>;
//# sourceMappingURL=index.d.ts.map