node-libcurl

    Interface CurlWsFrame

    WebSocket frame metadata

    This structure contains information about a WebSocket frame received or being sent. It is returned by Easy#wsMeta when called from within a WRITEFUNCTION callback, or as part of the return value from Easy#wsRecv.

    The naming convention of the fields is following libcurl's own naming convention.

    interface CurlWsFrame {
        age: number;
        bytesleft: number;
        flags: CurlWs;
        len: number;
        offset: number;
    }
    Index

    Properties

    age bytesleft flags len offset

    Properties

    age: number

    The age of this struct. Always zero for now.

    bytesleft: number

    If this is not a complete fragment, the bytesleft field informs about how many additional bytes are expected to arrive before this fragment is complete. If zero, the frame is complete.

    flags: CurlWs

    Bitmask describing the WebSocket frame. See CurlWs for flag values.

    len: number

    The length of the current data chunk.

    offset: number

    When this chunk is a continuation of frame data already delivered, this is the offset into the final frame data where this piece belongs.

    Settings

    Member Visibility

    On This Page

    Properties
    MMNEPVFCICPMFPCPTTAAATR