@gj-kit/nest-operations-jobs API

This reference is generated from the 0.1.1 release declaration snapshot. Unpublished main APIs are not shown.

`Root entry`

Import: @gj-kit/nest-operations-jobs

Symbol	Kind
`AnyOperationsJob`	type
`createOperationsJobsController`	function
`fromNestLogger`	function
`InjectJobRegistry`	constant
`InjectJobRunner`	constant
`InjectJobRunStore`	constant
`JOB_CLOCK`	constant
`JOB_REGISTRY`	constant
`JOB_RUN_STORE`	constant
`JOB_RUNNER`	constant
`JOB_TRIGGER_AUTHENTICATOR`	constant
`JobCatalogEntry`	interface
`JobClock`	interface
`JobExecuteOptions`	interface
`JobExecutionResult`	type
`JobInputValidator`	interface
`JobLogger`	interface
`JobOverlapPolicy`	type
`JobReapScope`	type
`JobRegistry`	interface
`JobRegistryView`	interface
`JobRunClaim`	interface
`JobRunClaimRequest`	interface
`JobRunCompleteRequest`	interface
`JobRunHeartbeatRequest`	interface
`JobRunner`	interface
`JobRunnerOptions`	interface
`JobRunReapRequest`	interface
`JobRunRecordOutcome`	type
`JobRunSkippedRequest`	interface
`JobRunStatus`	type
`JobRunStore`	interface
`JobSchedule`	interface
`JobSkipReason`	type
`JobSummary`	type
`JobTerminalStatus`	type
`JobTimerCancel`	type
`JobTrigger`	interface
`JobTriggerAuthOptions`	interface
`JobTriggerIdentity`	interface
`JobTriggerSource`	type
`JobTriggerTokenVerifier`	interface
`OPERATIONS_JOB_CLI_EXIT`	constant
`OPERATIONS_JOB_METADATA`	constant
`OperationsJob`	interface
`OperationsJobCliOptions`	interface
`OperationsJobContext`	interface
`OperationsJobDefinition`	function
`OperationsJobsControllerOptions`	interface
`OperationsJobsError`	type
`OperationsJobsErrorCode`	type
`OperationsJobsErrorContext`	interface
`OperationsJobsGuard`	class
`OperationsJobsModule`	class
`OperationsJobsModuleAsyncOptions`	interface
`OperationsJobsModuleOptions`	interface
`runOperationsJobCli`	function
`SchedulerHttpTarget`	interface
`SchedulerHttpTargetOptions`	interface
`toHttpException`	function

`./core`

Import: @gj-kit/nest-operations-jobs/core

Symbol	Kind
`AnyOperationsJob`	type
`assertJobSchedule`	function
`assertJobSucceeded`	function
`bearerToken`	function
`createJobRegistry`	function
`createJobRunner`	function
`createJobTriggerAuthenticator`	function
`DEFAULT_ERROR_TEXT_LIMIT`	constant
`DEFAULT_HEARTBEAT_INTERVAL_MS`	constant
`DEFAULT_JOB_TIMEOUT_MS`	constant
`DEFAULT_STALE_RUN_AFTER_MS`	constant
`isJobKey`	function
`isOperationsJobsError`	function
`JOB_KEY_PATTERN`	constant
`jobCatalog`	function
`JobCatalogEntry`	interface
`JobClock`	interface
`JobExecuteOptions`	interface
`JobExecutionResult`	type
`JobInputValidator`	interface
`jobKeySlug`	function
`JobLogger`	interface
`JobOverlapPolicy`	type
`JobReapScope`	type
`JobRegistry`	interface
`JobRegistryView`	interface
`JobRunClaim`	interface
`JobRunClaimRequest`	interface
`JobRunCompleteRequest`	interface
`JobRunHeartbeatRequest`	interface
`JobRunner`	interface
`JobRunnerOptions`	interface
`JobRunReapRequest`	interface
`JobRunRecordOutcome`	type
`JobRunSkippedRequest`	interface
`JobRunStatus`	type
`JobRunStore`	interface
`JobSchedule`	interface
`JobSkipReason`	type
`JobSummary`	type
`JobTerminalStatus`	type
`JobTimerCancel`	type
`JobTrigger`	interface
`JobTriggerAuthOptions`	interface
`JobTriggerIdentity`	interface
`jobTriggerPath`	function
`JobTriggerSource`	type
`JobTriggerTokenVerifier`	interface
`looksLikeJwt`	function
`MAX_JOB_KEY_LENGTH`	constant
`OperationsJob`	interface
`OperationsJobContext`	interface
`OperationsJobsError`	class
`OperationsJobsErrorCode`	type
`OperationsJobsErrorContext`	interface
`SchedulerHttpTarget`	interface
`SchedulerHttpTargetOptions`	interface
`schedulerHttpTargets`	function
`silentJobLogger`	function
`systemJobClock`	function
`timingSafeSecretMatch`	function

`./testing`

Import: @gj-kit/nest-operations-jobs/testing

Symbol	Kind
`fakeJobClock`	function
`FakeJobClock`	interface
`JobRunStoreContractCase`	interface
`jobRunStoreContractCases`	function
`JobRunStoreContractOptions`	interface
`JobRunStoreObligation`	type
`memoryJobRunStore`	function
`MemoryJobRunStore`	interface
`MemoryJobRunStoreOptions`	interface
`RecordedLogEntry`	interface
`recordingJobLogger`	function
`RecordingJobLogger`	interface
`StoredJobRun`	interface