Skip to main content

Reference

Each block has its own reference pages, which describe what its data types are for, how to construct them, and the operations they offer. Find a block by name, or jump to an area. The overview compares every block in one table, and the API reference lists every type and method.

29 blocks in 11 areas

Meta Programming

2 blocks
Schema
JVM · JSScala 2.13 · 3.x

Type-safe schemas with automatic codec, optic, and validator derivation

zio-blocks-schema

Also ships as zio-blocks-schema-avro, zio-blocks-schema-bson, zio-blocks-schema-csv, zio-blocks-schema-messagepack, zio-blocks-schema-thrift, zio-blocks-schema-toon, zio-blocks-schema-xml, zio-blocks-schema-yaml

TypeId
JVM · JSScala 2.13 · 3.x

Compile-time type identity with rich metadata

zio-blocks-typeid

Resource Management

1 block
Scope
JVM · JSScala 2.13 · 3.x

Compile-time safe resource boundaries that keep values from escaping their lifetime

zio-blocks-scope

Dependency Injection

2 blocks
Wire
JVM · JSScala 2.13 · 3.x

Compile-time safe recipes for constructing a service and its dependencies

zio-blocks-scope
Context
JVM · JSScala 2.13 · 3.x

Type-indexed heterogeneous collections

zio-blocks-context

Configuration & Feature Flags

1 block
Configuration
JVM · JSScala 2.13 · 3.x

Typed configuration loading, feature flags, and rollout rules

zio-blocks-config

Also ships as zio-blocks-config-yaml, zio-blocks-config-json, zio-blocks-config-hocon

Web & HTTP

8 blocks
MediaType
JVM · JSScala 2.13 · 3.x

Type-safe IANA media types with 2,600+ predefined types

zio-blocks-mediatype
HTTP Model
JVM · JSScala 2.13 · 3.x

Pure HTTP data model with URL parsing, headers, cookies, and forms

zio-blocks-http-model

Also ships as zio-blocks-http-model-schema

Endpoint
JVM · JSScala 2.13 · 3.x

Type-safe HTTP endpoint descriptors with composable codecs and typed auth

zio-blocks-endpoint
OpenAPI
JVM · JSScala 2.13 · 3.x

Type-safe OpenAPI 3.1 specification generation and rendering

zio-blocks-openapi
JWT
JVM · JSScala 2.13 · 3.x

Zero-dependency JWT signing and verification with HMAC, RSA, ECDSA and EdDSA support

zio-blocks-jwt
HTML
JVM · JSScala 2.13 · 3.x

Type-safe HTML templating with XSS protection

zio-blocks-html
Datastar
JVM · JSScala 3 only

Typed Datastar attribute and signal DSL, plus the SSE events that patch a live page

zio-blocks-datastar
HTMX
JVM · JSScala 3 only

Typed HTMX DSL for compile-time-checked HTMX attributes

zio-blocks-http-htmx

Data Types

3 blocks
Chunk
JVM · JSScala 2.13 · 3.x

High-performance immutable indexed sequences with zero-boxing builders

zio-blocks-chunk
Maybe
JVM · JSScala 2.13 · 3.x

Optional values that store a present reference as is, without a wrapper object (Scala 3)

zio-blocks-maybe
Combinators
JVM · JSScala 2.13 · 3.x

Compile-time composition and decomposition of tuples, eithers, and unions

zio-blocks-combinators

Concurrency

3 blocks
Async
JVM · JSScala 2.13 · 3.x

Zero-allocation asynchronous effect type with direct-style `await`

zio-blocks-async
Mux
JVM · JSScala 2.13 · 3.x

Thread-safe multiplexer for HTTP/2, QUIC, and WebSocket-style protocols

zio-blocks-mux
RingBuffer
JVM · JSScala 2.13 · 3.x

Lock-free bounded ring buffers (SPSC, SPMC, MPSC, MPMC)

zio-blocks-ringbuffer

Streams

1 block
Streams
JVM · JSScala 2.13 · 3.x

Pull-based streaming with typed errors, zero boxing, and synchronous or asynchronous execution

zio-blocks-streams

Telemetry

1 block
Telemetry
JVM · JSScala 2.13 · 3.x

Zero-dependency OpenTelemetry-aligned tracing, logging, and metrics

zio-blocks-telemetry

Also ships as zio-blocks-telemetry-otel

Persistence

4 blocks
SQL Module
JVM · JSScala 3 only

Type-safe JDBC wrapper with schema-derived codecs and a CRUD repository

zio-blocks-sql
ZIO Integration
JVMScala 3 only

ZIO integration with `ZIO.attemptBlocking` and `ZLayer`

zio-blocks-sql-zio
Data Migration
JVM · JSScala 3 only

Typed, online database schema migrations in three execution models, with no hand-written SQL

zio-blocks-data-migration
Projection
JVMScala 3 only

Event-sourced projections with per-entity SQLite storage

zio-blocks-projection

Tooling & Codegen

3 blocks
Code Generation
JVMScala 2.13 · 3.x

Generic Scala code generation IR and emitter

zio-blocks-codegen
Docs
JVM · JSScala 2.13 · 3.x

GitHub Flavored Markdown parsing, rendering, and programmatic construction

zio-blocks-markdown
Smithy
JVMScala 2.13 · 3.x

Smithy IDL parser and AST library for API modeling

zio-blocks-smithy