@s2-dev/streamstore - v0.30.0
    Preparing search index...

    Type Alias AppendData

    type AppendData = {
        body: API.AppendInput;
        headers?: {
            "s2-encryption-key"?: string;
            "s2-format"?: Format;
            "s2-stream-config"?: API.StreamConfig;
        };
        path: { stream: StreamNameStr };
        query?: never;
        url: "/streams/{stream}/records";
    }
    Index

    Properties

    body headers? path query? url

    Properties

    body

    body: API.AppendInput
    headers?: {
        "s2-encryption-key"?: string;
        "s2-format"?: Format;
        "s2-stream-config"?: API.StreamConfig;
    }

    Type Declaration

    • Optionals2-encryption-key?: string

      Encryption key material for append and read operations. Provide base64-encoded key when stream encryption is enabled.

    • Optionals2-format?: Format

      Defines the interpretation of record data (header name, header value, and body) with the JSON content type. Use raw (default) for efficient transmission and storage of Unicode data — storage will be in UTF-8. Use base64 for safe transmission with efficient storage of binary data.

    • Optionals2-stream-config?: API.StreamConfig

      JSON-encoded StreamConfig to apply if the stream is created on append or read. Unset fields inherit the basin's default stream configuration. Ignored if the stream already exists. Compact JSON is preferred.

    path: { stream: StreamNameStr }

    Type Declaration

    query?: never
    url: "/streams/{stream}/records"

    Settings

    Member Visibility

    On This Page

    Properties