channel

Documentation

Overview

Package channel provides utilities to create an Bubbletea model compatible with Go channels.

Index

• type DisposeMsg
• type Model
  • func (m *Model[T]) Dispose() tea.Msg
  • func (m Model[T]) Init() tea.Cmd
  • func (m Model[T]) Update(msg tea.Msg) (Model[T], tea.Cmd)

Types

type DisposeMsg

type DisposeMsg[T any] struct{}

DisposeMsg is a signal used to close the channel of the Model.

type Model

type Model[T any] struct {
	Channel chan T
	// OnInit is used to insert data into the channel and initialize the dispose method.
	OnInit func(chan T) func() error
	// contains filtered or unexported fields
}

Model is the object used to implement a bubbletea model with a channel.

func (*Model[T]) Dispose

func (m *Model[T]) Dispose() tea.Msg

Dispose is the signal that closes the model and executes the dispose function.

func (Model[T]) Init

func (m Model[T]) Init() tea.Cmd

Init emit a signal used to start listening the channel.

func (Model[T]) Update

func (m Model[T]) Update(msg tea.Msg) (Model[T], tea.Cmd)

Update prepare the dispose method and emit a tick for listening the channel.