@wdprlib/parser
    Preparing search index...

    Interface RatingState

    An authorized, registered rating supplied by the host for the current viewer.

    interface RatingState {
        aggregate: RatingAggregate | null;
        allowedVotes: readonly RatingVote[];
        canCancel: boolean;
        canVote: boolean;
        currentVote: RatingVote | null;
        label: string;
        ref: RatingRef;
        voteLabels?: Readonly<Partial<Record<RatingVote, string>>>;
    }
    Index

    Properties

    aggregate allowedVotes canCancel canVote currentVote label ref voteLabels?

    Properties

    aggregate: RatingAggregate | null

    Null hides all aggregate values without preventing voting.

    allowedVotes: readonly RatingVote[]

    Host policy: e.g. [1, -1], [1], [-1], or [1, 0, -1].

    canCancel: boolean

    Independent of permission to cast a vote.

    canVote: boolean

    False keeps a visible, read-only widget. Omit the state to hide it entirely.

    currentVote: RatingVote | null

    Null means no vote; zero is a saved neutral vote.

    label: string
    ref: RatingRef
    voteLabels?: Readonly<Partial<Record<RatingVote, string>>>

    Plain-text vote labels, e.g. { 1: "+", 0: "φ", [-1]: "-" }. Omitted entries use + / Ø / –.

    Settings

    Member Visibility

    On This Page

    Properties