Skip to content
Monque v1.2.0

CursorOptions

Defined in: packages/core/src/jobs/types.ts:267

Options for cursor-based pagination.

Example

Section titled “Example”
const options: CursorOptions = {
  limit: 50,
  direction: CursorDirection.FORWARD,
  filter: { status: JobStatus.PENDING },
};

Properties

Section titled “Properties”

cursor?

Section titled “cursor?”
optional cursor: string;

Defined in: packages/core/src/jobs/types.ts:268

direction?

Section titled “direction?”
optional direction: CursorDirectionType;

Defined in: packages/core/src/jobs/types.ts:270

filter?

Section titled “filter?”
optional filter: Pick<GetJobsFilter, "name" | "status">;

Defined in: packages/core/src/jobs/types.ts:271

limit?

Section titled “limit?”
optional limit: number;

Defined in: packages/core/src/jobs/types.ts:269