@nteract/messaging/lib/wire-protocol.d.ts

Messaging mechanics for nteract apps (jupyter spec)

/// <reference types="node" />
import { JupyterMessageHeader, MessageType } from "./types";
export interface RawJupyterMessage<MT extends MessageType = MessageType, C = any> {
    header: JupyterMessageHeader<MT>;
    parent_header: JupyterMessageHeader<any>;
    metadata: object;
    content: C;
    buffers: Array<Buffer>;
    idents: Array<Buffer>;
}
/**
 * Convert raw message frames from a Jupyter ZeroMQ connection to the object based JupyterMessage format
 *
 * @param messageFrames individual components of a message
 * @param _scheme only sha256 is supported at the moment
 * @param key HMAC key for frames 2+
 */
export declare function decode(messageFrames: Array<Buffer>, key?: string, _scheme?: string): RawJupyterMessage;
/**
 * Convert from the object based jupyter message to raw message frames
 */
export declare function encode(_message: Partial<RawJupyterMessage>, key?: string, _scheme?: string): Buffer[];