Interface PoolInfo

Pool information.

interface PoolInfo {
    backPressure?: boolean;
    busyWorkerNodes: number;
    defaultStrategy:
        | "ROUND_ROBIN"
        | "LEAST_USED"
        | "LEAST_BUSY"
        | "LEAST_ELU"
        | "FAIR_SHARE"
        | "WEIGHTED_ROUND_ROBIN"
        | "INTERLEAVED_WEIGHTED_ROUND_ROBIN";
    elu?: {
        active: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        idle: {
            average?: number;
            maximum: number;
            median?: number;
            minimum: number;
        };
        utilization: {
            average?: number;
            median?: number;
        };
    };
    executedTasks: number;
    executingTasks: number;
    failedTasks: number;
    idleWorkerNodes: number;
    maxQueuedTasks?: number;
    maxSize: number;
    minSize: number;
    queuedTasks?: number;
    ready: boolean;
    runTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    };
    started: boolean;
    stealingWorkerNodes?: number;
    stolenTasks?: number;
    strategyRetries: number;
    type: "fixed" | "dynamic";
    utilization?: number;
    version: string;
    waitTime?: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    };
    worker: "thread" | "cluster";
    workerNodes: number;
}

Properties

backPressure? busyWorkerNodes defaultStrategy elu? executedTasks executingTasks failedTasks idleWorkerNodes maxQueuedTasks? maxSize minSize queuedTasks? ready runTime? started stealingWorkerNodes? stolenTasks? strategyRetries type utilization? version waitTime? worker workerNodes

Properties

Optional ReadonlybackPressure

backPressure?: boolean

ReadonlybusyWorkerNodes

busyWorkerNodes: number

Pool busy worker nodes.

ReadonlydefaultStrategy

defaultStrategy:
    | "ROUND_ROBIN"
    | "LEAST_USED"
    | "LEAST_BUSY"
    | "LEAST_ELU"
    | "FAIR_SHARE"
    | "WEIGHTED_ROUND_ROBIN"
    | "INTERLEAVED_WEIGHTED_ROUND_ROBIN"

Optional Readonlyelu

elu?: {
    active: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    };
    idle: {
        average?: number;
        maximum: number;
        median?: number;
        minimum: number;
    };
    utilization: {
        average?: number;
        median?: number;
    };
}

ReadonlyexecutedTasks

executedTasks: number

ReadonlyexecutingTasks

executingTasks: number

ReadonlyfailedTasks

failedTasks: number

ReadonlyidleWorkerNodes

idleWorkerNodes: number

Pool idle worker nodes.

Optional ReadonlymaxQueuedTasks

maxQueuedTasks?: number

ReadonlymaxSize

maxSize: number

ReadonlyminSize

minSize: number

Optional ReadonlyqueuedTasks

queuedTasks?: number

Readonlyready

ready: boolean

Optional ReadonlyrunTime

runTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}

Readonlystarted

started: boolean

Optional ReadonlystealingWorkerNodes

stealingWorkerNodes?: number

Pool stealing worker nodes.

Optional ReadonlystolenTasks

stolenTasks?: number

ReadonlystrategyRetries

strategyRetries: number

Readonlytype

type: "fixed" | "dynamic"

Optional Readonlyutilization

utilization?: number

Pool utilization.

Readonlyversion

version: string

Optional ReadonlywaitTime

waitTime?: {
    average?: number;
    maximum: number;
    median?: number;
    minimum: number;
}

Readonlyworker

worker: "thread" | "cluster"

ReadonlyworkerNodes

workerNodes: number

Pool total worker nodes.

Settings

Member Visibility

On This Page

Properties