observablehq

Documentation

Overview

Package observablehq fetches Observable HQ user profile data.

Index

• func AuthRequired() bool
• func Match(urlStr string) bool
• type Client
  • func New(_ 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 Observable HQ profiles are public.

func Match

func Match(urlStr string) bool

Match returns true if the URL is an Observable HQ profile URL.

Types

type Client

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

Client handles Observable HQ requests.

func New

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

New creates an Observable HQ client.

func (*Client) Fetch

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

Fetch retrieves an Observable HQ 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.