hexpm

Documentation

Overview

Package hexpm fetches Hex.pm (Elixir/Erlang packages) user profile data.

Index

• func AuthRequired() bool
• func Match(urlStr string) bool
• type Client
  • func New(ctx context.Context, opts ...Option) (*Client, error)
  • func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)
• type Option
  • func WithHTTPCache(httpCache httpcache.Cacher) Option
  • func WithLogger(logger *slog.Logger) Option

Functions

func AuthRequired

func AuthRequired() bool

AuthRequired returns false because Hex.pm profiles are public.

func Match

func Match(urlStr string) bool

Match returns true if the URL is a Hex.pm user profile URL.

Types

type Client

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

Client handles Hex.pm requests.

func New

func New(ctx context.Context, opts ...Option) (*Client, error)

New creates a Hex.pm client.

func (*Client) Fetch

func (c *Client) Fetch(ctx context.Context, urlStr string) (*profile.Profile, error)

Fetch retrieves a Hex.pm profile.

type Option

type Option func(*config)

Option configures a Client.

func WithHTTPCache

func WithHTTPCache(httpCache httpcache.Cacher) Option

WithHTTPCache sets the HTTP cache.

func WithLogger

func WithLogger(logger *slog.Logger) Option

WithLogger sets a custom logger.