Skip to content

voting-sdk 0.1.1

Install from the command line:
Learn more about npm packages
$ npm install @top-gg/voting-sdk@0.1.1
Install via package.json:
"@top-gg/voting-sdk": "0.1.1"

About this version

Top.gg-Voting-SDK

The offical vote SDK for Top.gg

Installation

npm i @top-gg/voting-sdk

Example receiving webhooks

const { VotingSDK } = require('@top-gg/voting-sdk');

const topgg = new VotingSDK("authorization", {
	testReminderTime: 5, // test vote remidners will be sent after 5 seconds
	port: 3000, 
  	remindersOptInDefault: true // reminders enabled for users by default
})

topgg.on("vote", (vote) => { // fires when someone votes
	console.log(`Vote event: ${JSON.stringify(vote)}`)
})
topgg.on("reminder", (reminder) => { // fires when someone should be reminded
	console.log(`reminder event: ${JSON.stringify(reminder)}`)
})
topgg.on("testVote", (vote) => {
	console.log(`test vote event: ${JSON.stringify(vote)}`)
})
topgg.on("testReminder", (reminder) => {
	console.log(`test reminder event: ${JSON.stringify(reminder)}`)
})

Getting vote information

	const userVoted = await topgg.hasVoted(user.id)
	console.log(userVoted) // true or false
	const userVotedAt = topgg.votedAt(user.id)
	console.log(userVotedAt) // when the user voted at

Setting a users opt-in status for reminders

	await topgg.setOpt(user.id, true); // opt in a user
	await topgg.setOpt(user.id, false); // opt out a user

Details


Assets

  • voting-sdk-0.1.1.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all