domain

Documentation

Index

• type ListWordsParams
• type Word
• type WordRepository
• type WordSearchRepository

Types

type ListWordsParams

type ListWordsParams struct {
	IDs []int
}

ListWordsParams holds a list of attributes that words can be filtered by.

type Word

type Word struct {
	ID   int
	Word string
}

Word holds the attributes of a word.

type WordRepository

type WordRepository interface {
	AddWord(ctx context.Context, word string) (*Word, error)
	ListWords(ctx context.Context, params ListWordsParams) ([]Word, error)
	RandomWord(ctx context.Context) (*Word, error)

	Close() error
}

WordRepository abstracts away the storage adapter.

type WordSearchRepository

type WordSearchRepository interface {
	IndexWord(ctx context.Context, word Word) error
	SearchWordsByPrefix(ctx context.Context, prefix string) ([]int, error)

	Close() error
}

WordSearchRepository abstracts away the search adapter.