@tak-ps/node-tak
    Preparing search index...

    Type Alias TAKOptions

    Configuration options for a TAK connection.

    Performance-related options control the write pipeline:

    write(cots)                                process()
    ───────────                                ─────────
     for each CoT:                             while queue has items:
       serialize to XML ──push()──►  Ring        pop socketBatchSize items
       (returns false   ◄────────   Buffer       join into one string
        when full)               (capacity =     socket.write(batch)
                             writeQueueSize)     stop if backpressure
     when full:
       setImmediate() yield                    triggered by:
       (lets process() drain)                    - write() calling process()
                                                 - socket 'drain' event

    const tak = await TAK.connect(url, auth, {
        writeQueueSize: 50_000,   // large buffer absorbs bursts
        socketBatchSize: 128,     // 128 strings per socket.write()
    });

    const tak = await TAK.connect(url, auth, {
        writeQueueSize: 400,      // small buffer keeps memory minimal
        socketBatchSize: 10,      // flush to socket every 10 items
    });
    type TAKOptions = {
        cot?: CoTOptions;
        id?: number | string;
        socketBatchSize?: number;
        type?: string;
        writeQueueSize?: number;
    }
    Index

    Properties

    cot? id? socketBatchSize? type? writeQueueSize?

    Properties

    cot?: CoTOptions

    Options passed through to @tak-ps/node-cot for CoT parsing (e.g., on incoming 'cot' events). Does not affect the write pipeline.

    id?: number | string

    Unique connection identifier. Appears in log messages for debugging. Useful when running multiple TAK connections in a single process.

    crypto.randomUUID()
    socketBatchSize?: number

    How many pre-serialized XML strings are popped from the ring buffer and joined into a single socket.write() call in process(). Higher values reduce syscall overhead and improve TLS frame packing, but increase per-write latency and the size of each socket write.

    64
    type?: string

    Connection type label. Informational only — helps distinguish connections in logs when multiple are active.

    'unknown'
    writeQueueSize?: number

    Capacity of the ring buffer that sits between write() and process(). When the queue is full, write() yields via setImmediate() until process() drains space. Larger values allow more XML strings to be buffered, increasing throughput at the cost of higher peak memory.

    10_000

    Settings

    Member Visibility

    On This Page

    Properties