Guide

Welcome to the Tyneq guide. Start with Getting Started if you are new, or jump to the section you need below.

Start Here

• Getting Started - installation, first pipeline, re-iteration, and convenience factories
• Core Concepts - streaming vs. buffering, the execution model, and the enumerator lifecycle
• Best Practices & Pitfalls - patterns to follow and common mistakes to avoid

Using Tyneq

• Operators - all streaming, buffering, and terminal operators with examples
• Ordering - orderBy, thenBy, custom comparers, and TyneqComparer
• Grouping & Joins - groupBy, join, groupJoin, and countBy
• Set Operations - distinct, union, intersect, except, and their key-based variants

Extending Tyneq

• Custom Operators - register your own streaming, buffering, or terminal operators
• Plugin Internals - sequence factory pattern, bridge methods, and custom sequence types

Diving Deeper

• Query Plan & Compiler - inspect, walk, transform, and compile pipelines as data
• Terminology - reference definitions for every type and concept

Project

• Contributing - how to add a built-in operator, run tests, and submit a PR