tubeless API reference

Generated from the package's emitted declaration files. Do not edit manually; run bun run api:generate from the package root.

Package: tubeless

Public entrypoints

Entrypoint	Declaration	Surface hash	Exported symbols
`tubeless`	`./dist/core/pipeline.d.ts`	`4c9eea9c3243f304493c43578af2c64d9406610054db5694519145854393ac15`	75
`tubeless/batch`	`./dist/utilities/batch.d.ts`	`6b7fe7d6eec6532cc835505517c3481e4290a2a606c2fddf6c80367f5c76c5f5`	7
`tubeless/cli`	`./dist/cli/cli.d.ts`	`afcd70f9ca23dac58af7a5256fb593cf3dd9b4f4718910ba30a6e0db838f3fcc`	35
`tubeless/node`	`./dist/node/node.d.ts`	`2ded0b2084ecf401c09b414d3af7108daf149192f0cbd7efc03f1ca7020b320f`	8
`tubeless/rate-limit`	`./dist/utilities/rate-limit.d.ts`	`5cd093bb780a19e44b087b01e2b38e06f07e7233c9920988ba399036e319c368`	1
`tubeless/render`	`./dist/render/render.d.ts`	`5b3c6183d1df53eb5474cde672eb2614f6887381d65656544c30a9c5ce8d7b37`	6
`tubeless/reporter`	`./dist/reporter/reporter-entry.d.ts`	`b745445b09b8122bd58c7c40eb910b9ccfd916c4664cd2e2d301a2b98961e59e`	13
`tubeless/retry`	`./dist/utilities/retry.d.ts`	`f91f83f8e31e3e629ed90d1b04656110572ea970187a92369f0908cd75ae8f00`	4
`tubeless/run-store`	`./dist/run-store/run-store.d.ts`	`db7d9e8c4f82bcb22d5ec7eecb47814f9fdfc961a8a11fc805397042a7040b7f`	18
`tubeless/run-store/sqlite`	`./dist/run-store/run-store-sqlite.d.ts`	`a9363f5b1c72ebfd508bd66827e5a931d243ed2a804dbd99070e8abd6d0010d1`	3
`tubeless/run-store/ndjson`	`./dist/run-store/run-store-ndjson.d.ts`	`011bef12c4c8bc4b1eedfb5dba72e6d1eccf4ebf04a7306837fef978a32fc53b`	3
`tubeless/workbench/studio`	`./dist/workbench/workbench-studio.d.ts`	`6108782771ca4752fa95473cf5cbb1353e0bf2cda32554cfd20fcfefb21010b8`	6
`tubeless/workbench/project`	`./dist/workbench/workbench-project.d.ts`	`eac0931b2968d98c1b7d41503c1ea61477a2685e8cfebd22863255fce67085a7`	6
`tubeless/run-store/ui`	`./dist/studio/run-store-ui.d.ts`	`69e1f6c6508507b8cd346dc94c6a877b1e8b22d29e2c9f9212366677afc6d91b`	9
`tubeless/testing`	`./dist/testing/testing.d.ts`	`150386a43659704068ce0219dbacb8f71dd9d83f35ac0859c197e59721ab96ea`	7
`tubeless/tracing`	`./dist/tracing/tracing.d.ts`	`4c9eea9c3243f304493c43578af2c64d9406610054db5694519145854393ac15`	9
`tubeless/tracing/json`	`./dist/tracing/tracing-json.d.ts`	`d19223de841ea24d9c6ab6342bbfdcbeb158f700e54b4072a7d334a309add820`	2
`tubeless/tracing/otel`	`./dist/tracing/tracing-otel.d.ts`	`1ea929831eb01e14e7717bb13e12f1bc6c686411eed41849cbdd493490bfe06a`	4

Symbols

`tubeless`

AnyStep
createRunId
createSteps
defaultPipelineContext
definePipeline
formatMappedChildProgressMessage
FormatMappedChildProgressOptions
InferSchemaInput
InferSchemaOutput
MappedChildProgressDetail
mappedChildProgressDetails
MappedChildProgressOptions
MappedChildProgressSnapshot
mappedChildProgressUnits
MappedChildProgressUnits
Pipeline
PIPELINE_FINALIZE_STEP_ID
PIPELINE_MERMAID_DIRECTIONS
PipelineContext
PipelineDefinition
PipelineDefinitionError
PipelineError
PipelineErrorCause
PipelineErrorCode
PipelineErrorKind
PipelineErrorPhase
PipelineExecutionContext
PipelineExecutionError
PipelineFanOutDiagnostics
PipelineFanOutFailure
PipelineHooks
PipelineLogger
PipelineMermaidDirection
PipelineMermaidOptions
PipelinePlan
PipelinePlanStep
PipelineRun
PipelineRunControls
PipelineRunOptions
PipelineRunStatus
PipelineRuntime
PipelineStepCancelledEvent
PipelineStepCancelledReport
PipelineStepCompleteEvent
PipelineStepCompleteReport
PipelineStepContext
PipelineStepFailedEvent
PipelineStepFailedReport
PipelineStepLifecycleStatus
PipelineStepPlannedEvent
PipelineStepProgress
PipelineStepProgressDetail
PipelineStepProgressDetailStatus
PipelineStepProgressEvent
PipelineStepReport
PipelineStepReportStatus
PipelineStepSelectionReason
PipelineStepSkippedEvent
PipelineStepSkippedReport
PipelineStepSkipReason
PipelineStepStartEvent
PipelineStepStatus
PipelineValidationIssue
RemoteStepAdapter
requireOutputs
RUN_MODEL_VERSION
StandardSchemaV1
StandardSchemaV1Issue
StandardSchemaV1Props
StandardSchemaV1Result
Step
StepFactory
StepSkipDecision
toMappedChildStepProgress
ToMappedChildStepProgressOptions

`tubeless/batch`

chunk
ConcurrentSettleResult
ConcurrentWorker
runBatched
runConcurrent
RunConcurrentOptions
runConcurrentSettled

`tubeless/cli`

CliBooleanParam
CliCheckpointConfig
CliCommand
CliCommandConfig
CliCommandDescriptor
CliContext
CliHelpRequested
CliNumberParam
CliParam
CliParameterDescriptor
CliParams
CliParamsSchema
CliParamType
CliParseResult
CliPathParam
CliStringParam
CliValidationError
defineCommand
definePipelineCommand
DefinePipelineCommandConfig
MultiSelectChoice
MultiSelectResult
normalizeMultiSelectChoices
parseMultiSelectInput
ParseMultiSelectInputOptions
PipelineCliBuiltins
PipelineCliParseResult
PipelineCliValues
PipelineCommand
PipelineCommandHookConfig
PipelineCommandHookContext
PipelineCommandHookSets
promptMultiSelect
PromptMultiSelectOptions
TUBELESS_WORKBENCH_EXIT_CODE

`tubeless/node`

CheckpointStore
definePaths
openCheckpoint
readJson
requireEnv
resetDir
withCheckpointedBatch
writeJson

`tubeless/rate-limit`

RateLimiter

`tubeless/render`

PipelineHumanRenderOptions
PipelineJsonRenderOptions
PipelinePlanRenderOptions
PipelineRenderOptions
renderPipelineError
renderPipelinePlan

`tubeless/reporter`

createPipelineReporter
createRunReporter
PipelineReporterConfig
PipelineReporterController
PipelineReporterMode
PipelineReporterOptions
ReporterColorMode
ReporterOutput
ReporterSymbolMode
ReporterTerminalCapabilities
ResolvedPipelineReporterMode
RunReporterConfig
RunReporterOptions

`tubeless/retry`

RetryAttemptContext
RetryOperation
RetryOptions
withRetry

`tubeless/run-store`

createPipelineRunProjector
PipelineRunEventQuery
PipelineRunEventReader
PipelineRunEventStore
PipelineRunProjector
PipelineRunStoreSnapshot
projectPipelineRun
projectPipelineRunStore
StoredNestedPipeline
StoredPipelineAttempt
StoredPipelineDefinition
StoredPipelineDefinitionStep
StoredPipelineEvent
StoredPipelineLog
StoredPipelineRun
StoredPipelineRunStatus
StoredPipelineStep
StoredRemote

`tubeless/run-store/sqlite`

openSqlitePipelineRunStore
OpenSqlitePipelineRunStoreOptions
SqlitePipelineRunStore

`tubeless/run-store/ndjson`

NdjsonPipelineRunStore
openNdjsonPipelineRunStore
OpenNdjsonPipelineRunStoreOptions

`tubeless/workbench/studio`

definePipelineStudio
isPipelineStudioConfig
PIPELINE_STUDIO_CONFIG_VERSION
PipelineStudioCommandModule
PipelineStudioConfig
PipelineStudioConfigInput

`tubeless/workbench/project`

definePipelineProject
isPipelineProjectManifest
PIPELINE_PROJECT_MANIFEST_VERSION
PipelineProjectCommandModule
PipelineProjectManifest
PipelineProjectManifestInput

`tubeless/run-store/ui`

PipelineRunStudioCancelResult
PipelineRunStudioCommand
PipelineRunStudioHistoryMaintenance
PipelineRunStudioLauncher
PipelineRunStudioLaunchRequest
PipelineRunStudioLaunchResult
PipelineRunStudioOptions
PipelineRunStudioServer
startPipelineRunStudio

`tubeless/testing`

createPipelineTestRuntime
PipelineTestClock
PipelineTestLogEntry
PipelineTestLogLevel
PipelineTestRuntime
PipelineTestRuntimeOptions
PipelineTestSleep

`tubeless/tracing`

composeTraceExporters
PipelineTraceAttributes
PipelineTraceAttributeValue
PipelineTraceContext
PipelineTraceError
PipelineTraceEvent
PipelineTraceEventName
PipelineTraceExporter
PipelineTracingOptions

`tubeless/tracing/json`

createJsonTraceExporter
JsonTraceExporterOptions

`tubeless/tracing/otel`

createOpenTelemetryTraceExporter
OpenTelemetryLikeSpan
OpenTelemetryLikeTracer
OpenTelemetryTraceExporterOptions