JustinLove/elm-twitch-api/7.0.0

Twitch.Helix.BitsLeaderboard

JSON Decoders for Helix Bits Leaderboard responses.

Use these pieces to pull out the parts your application needs.

import Twitch.Helix.BitsLeaderboard as BitsLeaderboard
import Json.Decode exposing (..)


bitsLeaderboard : Decoder (List Cheer)
bitsLeaderboard = BitsLeaderboard.response bitsLeader


bitsLeader : Decoder Cheer
bitsLeader =
  map3 Cheer
    BitsLeaderboard.userId
    BitsLeaderboard.userName
    BitsLeaderboard.score

Field decoders

userId : Decoder UserId

Id of the user on the leaderboard

userName : Decoder String

Name of the user on the leaderboard

score : Decoder Int

Score or bit value

rank : Decoder Int

Leaderboard position

Response decoder

response : Decoder a -> Decoder (List a)

Decode individual records from the api response using the specified decoder

Sample Data

sample data for bootstrapping and testing