batchan

README

BatChan

A lightweight Go library for batching values from a channel with support for size-based and optional timeout-based flushing.

Features

• Batch items from a channel based on size
• Flush batches after a timeout, even if not full
• Zero-dependency, idiomatic Go

Installation

go get github.com/floatdrop/batchan

Usage

package main

import (
	"fmt"
	"time"

	"github.com/floatdrop/batchan"
)

func main() {
	input := make(chan string, 5)
	batches := batchan.New(input, 3)

	go func() {
		inputs := []string{"A", "B", "C", "D", "E"}
		for _, v := range inputs {
			input <- v
		}
		close(input)
	}()

	for v := range batches {
		fmt.Println("Got:", v)
	}

	// Output:
	// Got: [A B C]
	// Got: [D E]
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Documentation

Index

• func New[T any](in <-chan T, size int, opts ...option[T]) <-chan []T
• func WithSplitFunc[T any](splitFunc func(T, T) bool) option[T]
• func WithTimeout[T any](timeout time.Duration) option[T]

Examples

• New

Functions

func New

func New[T any](in <-chan T, size int, opts ...option[T]) <-chan []T

Example

package main

import (
	"fmt"

	"github.com/floatdrop/batchan"
)

func main() {
	input := make(chan string, 5)
	batches := batchan.New(input, 3)

	go func() {
		inputs := []string{"A", "B", "C", "D", "E"}
		for _, v := range inputs {
			input <- v
		}
		close(input)
	}()

	for v := range batches {
		fmt.Println("Got:", v)
	}

}

Output:

Got: [A B C]
Got: [D E]

func WithSplitFunc

func WithSplitFunc[T any](splitFunc func(T, T) bool) option[T]

func WithTimeout

func WithTimeout[T any](timeout time.Duration) option[T]