StateAdapterConfig

Type

Signature

type StateAdapterConfig<TJobId, TWorkerId> = {
  countCap: number;
  generateJobId: () => TJobId;
  generateWorkerId: () => TWorkerId;
  maxBlockersPerJob: number;
  validateJobId: (id) => boolean;
  validateWorkerId: (id) => boolean;
};

core/src/state-adapter/state-adapter.ts:127

A state adapter's resolved configuration, with defaults applied.

Type Parameters

  • TJobId
    extends string
    The job ID type
  • TWorkerId
    extends string
    The worker ID type

Properties

  • countCap
    number

    Per-status count at which countChainsByTypeName and countJobsByTypeName stop counting and report hasMore.

generateJobId

Signature

generateJobId: () => TJobId;

core/src/state-adapter/state-adapter.ts:129

Generates a job ID.

Returns

TJobId

generateWorkerId

Signature

generateWorkerId: () => TWorkerId;

core/src/state-adapter/state-adapter.ts:133

Generates a new worker ID on every call.

Returns

TWorkerId

  • maxBlockersPerJob
    number

    Maximum number of blocker chains per job.

validateJobId

Signature

validateJobId: (id) => boolean;

core/src/state-adapter/state-adapter.ts:131

Checks a job ID.

Parameters

  • id
    TJobId

Returns

boolean

validateWorkerId

Signature

validateWorkerId: (id) => boolean;

core/src/state-adapter/state-adapter.ts:135

Checks a worker ID.

Parameters

  • id
    TWorkerId

Returns

boolean

esc

Search guides, integrations and every exported symbol.

↑ ↓ to navigate↵ to open