ipcheck

Documentation

Overview

Package ipcheck provides a client for detecting the caller's public IP address.

Index

• Variables
• type Client
  • func New(options ...Option) *Client
  • func (c *Client) PublicIP(ctx context.Context) (*Response, error)
• type Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithURL(url *url.URL) Option
  • func WithUserAgent(userAgent string) Option
• type Response
  • func PublicIP(ctx context.Context) (*Response, error)

Variables

var ErrStatus = errors.New("status code error")

ErrStatus represents a non success status code error.

Types

type Client

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

Client fetches the caller's public IP address from Nine's IP check endpoint.

func New

func New(options ...Option) *Client

New creates a new Client with the given options.

func (*Client) PublicIP

func (c *Client) PublicIP(ctx context.Context) (*Response, error)

PublicIP returns the caller's public IP address as reported by the endpoint.

type Option

type Option func(*Client)

Option is a function that configures a Client.

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient configures the HTTP client to use.

func WithURL

func WithURL(url *url.URL) Option

WithURL configures the endpoint URL to query.

func WithUserAgent

func WithUserAgent(userAgent string) Option

WithUserAgent configures the User-Agent header to use.

type Response

type Response struct {
	Blocked    bool       `json:"blocked"`
	RemoteAddr netip.Addr `json:"remoteAddr"`
}

Response is the JSON response from the IP check endpoint.

func PublicIP

func PublicIP(ctx context.Context) (*Response, error)

PublicIP returns the caller's public IP address as reported by the endpoint.