Agenda - v6.0.0
    Preparing search index...

    Interface JobsQueryOptions

    Database-agnostic query options for jobs

    interface JobsQueryOptions {
        data?: unknown;
        id?: string;
        ids?: string[];
        includeDisabled?: boolean;
        limit?: number;
        name?: string;
        names?: string[];
        search?: string;
        skip?: number;
        sort?: JobsSort;
        state?: JobState;
    }
    Index

    Properties

    data? id? ids? includeDisabled? limit? name? names? search? skip? sort? state?

    Properties

    data?: unknown

    Filter by job data (exact match or partial object match)

    id?: string

    Filter by job ID

    ids?: string[]

    Filter by job IDs (multiple)

    includeDisabled?: boolean

    Include disabled jobs (default: true)

    limit?: number

    Maximum number of jobs to return

    name?: string

    Filter by job name

    names?: string[]

    Filter by job names (multiple)

    search?: string

    Text to search in job name

    skip?: number

    Number of jobs to skip (pagination)

    sort?: JobsSort

    Sort order

    state?: JobState

    Filter by computed state

    Settings

    Member Visibility

    On This Page

    Properties