Cleaned up documentation and removed stubs and TODOs throughout the application
This commit is contained in:
17
sinks/doc.go
17
sinks/doc.go
@@ -1,18 +1,27 @@
|
||||
// Package sinks provides sink abstractions, a sink driver registry, and several
|
||||
// built-in sink drivers.
|
||||
// Package sinks defines the feedkit sink interface, sink driver registry, and
|
||||
// built-in infrastructure sinks.
|
||||
//
|
||||
// External API surface:
|
||||
// - Sink: adapter interface that consumes event.Event values
|
||||
// - Registry / NewRegistry: named sink factory registry
|
||||
// - RegisterBuiltins: registers the built-in sink drivers in this binary
|
||||
//
|
||||
// Built-in drivers:
|
||||
// - stdout
|
||||
// - nats
|
||||
// - postgres
|
||||
//
|
||||
// Optional helpers from helpers.go:
|
||||
// - RegisterPostgresSchemaForConfiguredSinks: registers one Postgres schema
|
||||
// for each configured sink using driver=postgres
|
||||
//
|
||||
// # NATS built-in overview
|
||||
//
|
||||
// The NATS sink publishes each event as JSON to a configured subject.
|
||||
//
|
||||
// Required params:
|
||||
// - url: NATS server URL (for example, nats://localhost:4222)
|
||||
// - exchange: NATS subject to publish to
|
||||
// - subject: NATS subject to publish to
|
||||
//
|
||||
// Example config:
|
||||
//
|
||||
@@ -21,7 +30,7 @@
|
||||
// driver: nats
|
||||
// params:
|
||||
// url: nats://localhost:4222
|
||||
// exchange: feedkit.events
|
||||
// subject: feedkit.events
|
||||
//
|
||||
// # Postgres built-in overview
|
||||
//
|
||||
|
||||
Reference in New Issue
Block a user