Types · @purista/cli

AddPuristaQueueInput

Input for generating a queue, its primary worker, and optional producer command.

@purista/cliSource

Signature

AddPuristaQueueInput.tstypescript
type AddPuristaQueueInput = void

Properties

10 entries

codeWriterOptions

Property

Source
codeWriterOptions.tstypescript
codeWriterOptions: Partial<Options>

Optional formatting options passed to `code-block-writer`.

producer

Property

Source
producer.tstypescript
producer: QueueProducerOptions

Optional producer command generated with queue enqueue permissions.

projectRootPath

Property

Source
projectRootPath.tstypescript
projectRootPath: string

Project root path; defaults to `process.cwd()`.

puristaConfig

Property

Source
puristaConfig.tstypescript
puristaConfig: PuristaConfig

PURISTA project configuration controlling generated paths and casing.

puristaProject

Property

Source
puristaProject.tstypescript
puristaProject: PuristaProjectInfo

Discovered project metadata used to update the service composition.

queueDescription

Property

Source
queueDescription.tstypescript
queueDescription: string

Human-readable queue description written into generated docs and tests.

queueName

Property

Source
queueName.tstypescript
queueName: string

Logical queue name used by `getQueueBuilder`.

serviceName

Property

Source
serviceName.tstypescript
serviceName: string

Service name that owns the generated queue.

serviceVersion

Property

Source
serviceVersion.tstypescript
serviceVersion: string

Service version that owns the generated queue.

worker

Property

Source
worker.tstypescript
worker: QueueWorkerOptions

Primary worker generated for the queue.