Skip to content
Monque
v1.18.0
Search
Ctrl
K
Cancel
GitHub
Getting Started
Installation
Quick Start
Core Concepts
Jobs
Workers
Scheduling
Retry & Backoff
Job Management
Management
Management API
Express Adapter
Dashboard
Express Setup
Configuration
Screenshots
Advanced
Atomic Claim Pattern
Change Streams
Heartbeat Mechanism
Production Checklist
Integrations
Ts.ED
Roadmap
API Reference
Core API
classes
AggregationTimeoutError
ConnectionError
InvalidCronError
InvalidCursorError
InvalidJobIdentifierError
InvalidJobPriorityError
InvalidJobQueryError
JobStateError
Monque
MonqueError
NonRetryableError
PayloadTooLargeError
PayloadValidationError
ShutdownTimeoutError
WorkerRegistrationError
functions
applyJitter
calculateBackoff
calculateBackoffDelay
getNextCronDate
isCancelledJob
isCompletedJob
isFailedJob
isPendingJob
isPersistedJob
isProcessingJob
isRecurringJob
isValidJobStatus
validateCronExpression
validateJobName
validateUniqueKey
interfaces
BulkOperationResult
CursorOptions
CursorPage
EnqueueJob
EnqueueManyResult
EnqueueOptions
GetJobsFilter
Job
JobCursorFilter
JobCursorSort
JobSelector
JobWriteOptions
MonqueEventMap
MonqueOptions
ProcessingState
QueueStats
QueueViewSummary
QueueViewWorkerSummary
ScheduleOptions
WorkerOptions
@monque/core
type-aliases
JobCursorSortDirectionType
JobCursorSortFieldType
JobHandler
JobStatusType
JobSummary
JobSummaryPage
NowOptions
PersistedJob
variables
CursorDirection
DEFAULT_BASE_INTERVAL
DEFAULT_JITTER_FACTOR
DEFAULT_MAX_BACKOFF_DELAY
JobCursorSortDirection
JobCursorSortField
JobStatus
Ts.ED API
classes
MonqueModule
MonqueService
functions
buildJobName
collectJobMetadata
Cron
getJobToken
Job
JobController
resolveDatabase
validateDatabaseConfig
interfaces
CollectedJobMetadata
CronDecoratorOptions
CronMetadata
JobDecoratorOptions
JobMetadata
JobStore
MonqueTsedConfig
@monque/tsed
type-aliases
InjectorFn
ProviderType
variables
MONQUE
ProviderTypes
Management API
functions
createManagementRouter
createManagementSurface
generateManagementOpenApiDocument
interfaces
ManagementAuthorizationInput
ManagementMonque
ManagementOptions
ManagementPayloadSerializationInput
ManagementSurface
@monque/management
type-aliases
BulkActionErrorDto
BulkActionResultDto
CapabilitiesDto
CapabilityActionsDto
DeleteJobDto
JobCursorPageDto
JobDetailInputDto
JobDetailParamsDto
JobDto
JobListQueryDto
JobListSortByDto
JobListSortDirectionDto
JobSelectorDto
JobStatsQueryDto
JobStatusDto
ManagementAction
ManagementAuthorize
ManagementContract
ManagementErrorDto
ManagementOpenApiContext
ManagementPayloadSerializer
ManagementRouter
ProcessingActionDto
ProcessingQueryDto
ProcessingStateDto
QueueStatsDto
QueueViewQueryDto
QueueViewSummaryDto
QueueViewSummaryListDto
QueueViewWorkerDto
RescheduleJobInputDto
RescheduleJobRequestDto
SchedulerHealthDto
SelectedJobActionsDto
SetJobPriorityInputDto
SetJobPriorityRequestDto
variables
BulkActionErrorDtoSchema
BulkActionResultDtoSchema
CapabilitiesDtoSchema
CapabilityActionsDtoSchema
DeleteJobDtoSchema
JobCursorPageDtoSchema
JobDetailInputDtoSchema
JobDetailParamsDtoSchema
JobDtoSchema
JobListQueryDtoSchema
JobListSortByDtoSchema
JobListSortDirectionDtoSchema
JobSelectorDtoSchema
JobStatsQueryDtoSchema
JobStatusDtoSchema
managementContract
ManagementErrorDtoSchema
ProcessingActionDtoSchema
ProcessingQueryDtoSchema
ProcessingStateDtoSchema
QueueStatsDtoSchema
QueueViewQueryDtoSchema
QueueViewSummaryDtoSchema
QueueViewSummaryListDtoSchema
QueueViewWorkerDtoSchema
RescheduleJobInputDtoSchema
RescheduleJobRequestDtoSchema
SchedulerHealthDtoSchema
SelectedJobActionsDtoSchema
SetJobPriorityInputDtoSchema
SetJobPriorityRequestDtoSchema
Management Express API
functions
createManagementExpressRouter
interfaces
ManagementExpressContextInput
ManagementExpressOpenApiOptions
ManagementExpressRouterOptions
@monque/management-express
type-aliases
ManagementExpressContextFactory
ManagementExpressOpenApiServerUrl
Dashboard API
functions
getDashboardAssetDirectory
getDashboardAssetMetadata
getDashboardHtmlEntrypointPath
getDashboardManifestPath
parseDashboardRuntimeConfig
@monque/dashboard
type-aliases
DashboardAssetMetadata
DashboardRuntimeConfig
variables
DASHBOARD_RUNTIME_CONFIG_GLOBAL
DASHBOARD_RUNTIME_CONFIG_SCRIPT_ID
DashboardRuntimeConfigSchema
Dashboard Express API
functions
createDashboardExpressRouter
@monque/dashboard-express
type-aliases
DashboardExpressApiBaseUrlResolver
DashboardExpressApiBaseUrlValue
DashboardExpressRouterOptions
GitHub
getDashboardManifestPath
function
getDashboardManifestPath
()
:
string
;
Defined in:
asset-metadata.ts:26
Returns
Section titled “Returns”
string
