api

Documentation

Index

• type API
  • func New(us *users.Users, un *usernotes.UserNotes) *API
  • func (a *API) AsyncCreateUsers(ctx context.Context, users []users.User) error
  • func (a *API) CreateUser(ctx context.Context, u *users.User) (*users.User, error)
  • func (a *API) CreateUserNote(ctx context.Context, un *usernotes.Note) (*usernotes.Note, error)
  • func (a *API) ReadUserByEmail(ctx context.Context, email string) (*users.User, error)
  • func (a *API) ReadUserNote(ctx context.Context, userID string, noteID string) (*usernotes.Note, error)
  • func (a *API) ServerHealth() (map[string]any, error)
• type Server
  • func NewServer(us *users.Users, un *usernotes.UserNotes) Server
• type Subscriber
  • func NewSubscriber(us *users.Users) Subscriber

Types

type API

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

func New

func New(us *users.Users, un *usernotes.UserNotes) *API

func (*API) AsyncCreateUsers

func (a *API) AsyncCreateUsers(ctx context.Context, users []users.User) error

func (*API) CreateUser

func (a *API) CreateUser(ctx context.Context, u *users.User) (*users.User, error)

CreateUser is the API to create/signup a new user

func (*API) CreateUserNote

func (a *API) CreateUserNote(ctx context.Context, un *usernotes.Note) (*usernotes.Note, error)

func (*API) ReadUserByEmail

func (a *API) ReadUserByEmail(ctx context.Context, email string) (*users.User, error)

ReadUserByEmail is the API to read an existing user by their email

func (*API) ReadUserNote

func (a *API) ReadUserNote(ctx context.Context, userID string, noteID string) (*usernotes.Note, error)

func (*API) ServerHealth

func (a *API) ServerHealth() (map[string]any, error)

ServerHealth returns the health of the serever app along with other info like version

type Server

type Server interface {
	CreateUser(ctx context.Context, user *users.User) (*users.User, error)
	ReadUserByEmail(ctx context.Context, email string) (*users.User, error)
	CreateUserNote(ctx context.Context, un *usernotes.Note) (*usernotes.Note, error)
	ReadUserNote(ctx context.Context, userID string, noteID string) (*usernotes.Note, error)
	ServerHealth() (map[string]any, error)
}

Server has all the methods required to run the server

func NewServer

func NewServer(us *users.Users, un *usernotes.UserNotes) Server

type Subscriber

type Subscriber interface {
	AsyncCreateUsers(ctcx context.Context, users []users.User) error
}

Subscriber has all the methods required to run the subscriber

func NewSubscriber

func NewSubscriber(us *users.Users) Subscriber