batch-cluster
    Preparing search index...

    Interface BatchProcessOptions

    BatchProcessOptions have no reasonable defaults, as they are specific to the API of the command that BatchCluster is spawning.

    All fields must be set.

    interface BatchProcessOptions {
        exitCommand?: string;
        fail: string | RegExp;
        healthCheckCommand?: string;
        pass: string | RegExp;
        versionCommand: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    exitCommand? fail healthCheckCommand? pass versionCommand

    Properties

    exitCommand?: string

    Command to end the child batch process. If not provided (or undefined), stdin will be closed to signal to the child process that it may terminate, and if it does not shut down within endGracefulWaitTimeMillis, it will be SIGHUP'ed.

    fail: string | RegExp

    Expected text to print if a command fails. Cannot be blank. Strings will be interpreted as a regular expression fragment.

    healthCheckCommand?: string

    If provided, and healthCheckIntervalMillis is greater than 0, or the previous task failed, this command will be sent to child processes.

    If the command outputs to stderr or returns a fail string, the process will be considered unhealthy and recycled.

    pass: string | RegExp

    Expected text to print if a command passes. Cannot be blank. Strings will be interpreted as a regular expression fragment.

    versionCommand: string

    Low-overhead command to verify the child batch process has started correctly. This "startup command" is invoked immediately after spawn, and must complete successfully before any user tasks are assigned to the process.

    Typically this runs a version check (like -ver for ExifTool), hence the name. The command should be fast and reliable.

    If this command fails or times out (per BatchClusterOptions.spawnTimeoutMillis), the process is considered broken and will be terminated.

    Settings

    Member Visibility

    On This Page

    Properties