supinic

Documentation

Overview

Package supinic contains a client for the Supinic API. https://supinic.com/api/

Index

• type Client
  • func NewClient(userID, apiKey string) *Client
  • func NewClientForTesting(baseURL string) *Client
  • func (c *Client) StartPinging(ctx context.Context)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a Supinic API client.

func NewClient

func NewClient(userID, apiKey string) *Client

NewClient creates a new Client.

func NewClientForTesting

func NewClientForTesting(baseURL string) *Client

NewClientForTesting creates a new Client for testing.

func (*Client) StartPinging

func (c *Client) StartPinging(ctx context.Context)

StartPinging starts a background task to ping the Supinic API regularly to make sure the API knows the bot is still online. This function blocks and should be run within a goroutine.