Skip to content

Package exports

Symbols exported from logbun and from each subpath.

Updated View as Markdown

logbun

Symbol Role
AuditLogger Main class
AuditLoggerStats Stats snapshot type
ENTERPRISE_DEFAULTS { mode: 'durable', requireTenantId: true }
MemoryReliabilityAdapter Volatile journal/DLQ (persistent: false)
MemoryReliabilityOptions Constructor options type
DurableAdmissionSchedulingError Committed journal/DLQ, failed host wake-up
isDurableAdmissionSchedulingError Cross-bundle guard
sanitizeNamespace [a-zA-Z0-9_-]{1,64}
sanitizeTenantKey Filename-safe tenant key (__global__ when missing)
isTenantIdPresent Non-empty, non-whitespace tenantId
INTEGRITY_GENESIS 64 zero hex
verifyIntegrityChain Used by AuditLogger.verifyIntegrity
normalizeEncryptionKey 32 bytes / 64-hex / base64-of-32; rejects passphrases
randomUUIDv7 RFC 9562 UUIDv7 (Web Crypto)
uuidVersion / uuidVariantRfc / uuidv7TimestampMs UUIDv7 inspectors

Plus types: DurabilityMode, QueueFullBehavior, TenancyMode, LogbunLogInput, LogbunLog, LogbunQueryFilters, LogbunQueryResult, LogbunEvent, LogbunEventType, LogbunConfig, BatchingConfig, TenancyConfig, RetentionConfig, RetryConfig, ReliabilityAdapter, DLQEntry, ClaimedDlqBatch, JournalRecoveryResult, ReliabilityStats, DlqState, IAdapter, LogbunRequestContext.

_resetUUIDv7StateForTests exists in source for tests and is not a root export.

logbun/durability/filesystem

FileReliabilityAdapter, option types, resolveLogbunDir (alias resolveDataDir), sanitizeNamespace, InstanceLock, InstanceLockError, WALStorage, DLQStorage, size constants, and WAL/DLQ helper types/functions listed in src/durability/filesystem/index.ts.

logbun/durability/cloudflare

CloudflareReliabilityAdapter, option/state types, plus DurableAdmissionSchedulingError and isDurableAdmissionSchedulingError. ESM-only.

Adapters and plugins

  • logbun/adapters/bun-sqliteBunSQLiteAdapter, BunSQLiteAdapterConfig
  • logbun/adapters/tursoTursoAdapter, TursoAdapterConfig
  • logbun/adapters/clickhouseClickHouseAdapter, ClickHouseAdapterConfig, toClickHouseDateTime, fromClickHouseDateTime
  • logbun/adapters/cloudflare-analytics-engineCloudflareAnalyticsEngineAdapter, CloudflareAnalyticsEngineAdapterConfig, AnalyticsEngineDatasetLike, AnalyticsEngineDataPoint, ANALYTICS_ENGINE_SCHEMA, toAnalyticsEngineDataPoint, fromAnalyticsEngineRow
  • logbun/plugins/elysiaauditPlugin, AuditPluginOptions, extractWaitUntil
  • logbun/plugins/honocreateAuditMiddleware, AuditMiddlewareOptions, HonoAuditLog, LogbunHonoVariables
Navigation

Type to search…

↑↓ navigate↵ selectEsc close