xk6-tcp
    Preparing search index...

    Interface WriteOptions

    Configuration options for writing data to a TCP socket.

    // Write base64-encoded data
    await socket.write('SGVsbG8gV29ybGQ=', {
      encoding: 'base64',
      tags: { operation: 'send-auth-token' }
    });

    // Write hex-encoded binary data
    await socket.write('48656c6c6f', {
      encoding: 'hex',
      tags: { data_type: 'binary' }
    });
    interface WriteOptions {
        encoding?: string;
        tags?: Record<string, string>;
    }
    Index

    Properties

    encoding? tags?

    Properties

    encoding?: string

    The encoding to use when data is a string.

    Supported encodings:

    • 'utf8' / 'utf-8' (default): UTF-8 text encoding
    • 'ascii': Raw byte conversion for write operations
    • 'base64': Base64-encoded data decoded to bytes before sending
    • 'base64url': URL-safe Base64 decoded to bytes before sending
    • 'hex': Hexadecimal string decoded to bytes before sending

    Unsupported values are rejected. When writing an ArrayBuffer, this option is ignored.

    tags?: Record<string, string>

    Optional key-value pairs for metrics collection and logging. These tags will be attached to write-related metrics for this specific operation.

    Tags specified here will be merged with socket-level and connection-level tags. Operation-level tags take highest priority for duplicate keys.

    Settings

    On This Page

    Properties