Redix LogoDocumentation
API ReferenceSets

SPop

Remove and return one or more random members from a set

Syntax

Redix.SPop(key, count, callback)

Parameters

Prop

Type

Returns

Prop

Type

Examples

-- Pop one random winner
Redix.SPop('raffle:entries', 1, function(err, winner)
    if not err and winner then
        print('Winner:', winner)
        AnnounceWinner(winner)
    end
end)

-- Pop multiple winners
Redix.SPop('lottery:participants', 3, function(err, winners)
    if not err then
        for i, winner in ipairs(winners) do
            print('Winner #' .. i .. ':', winner)
        end
    end
end)