Member Junction
    Preparing search index...

    Interface RemoteOpInvokeOptions

    Options controlling how a Remote Operation is invoked. All fields are optional; the defaults produce a simple request/response call on the active provider.

    interface RemoteOpInvokeOptions {
        apiKeyHash?: string;
        clientIp?: string;
        contractFingerprint?: string;
        handle?: string;
        mode?: RemoteOpInvokeMode;
        onProgress?: (progress: RemoteOpProgress) => void;
        provider?: IMetadataProvider;
        requestOrigin?: string;
        sessionId?: string;
        user?: UserInfo;
    }
    Index

    Properties

    apiKeyHash? clientIp? contractFingerprint? handle? mode? onProgress? provider? requestOrigin? sessionId? user?

    Properties

    apiKeyHash?: string

    SHA-256 hash of the caller's MJ API key when authenticated via mj_sk_* API key / MCP.

    clientIp?: string

    Caller's network IP address as resolved by the HTTP host (req.ip), populated by the server transport for rate-limiting and forensic audit trails. Never use as an identity assertion.

    contractFingerprint?: string

    Optional contract fingerprint carried in the wire envelope so the server can reject a stale client loudly instead of mis-deserializing. Usually derived from the operation definition.

    handle?: string

    Optional opaque handle for an existing backing run (e.g. a ProcessRunID) forwarded into RemoteOpServerContext.handle during server-side dispatch.

    mode?: RemoteOpInvokeMode

    For LongRunning operations, how the caller wants to consume the run (default attached).

    onProgress?: (progress: RemoteOpProgress) => void

    Callback receiving streaming RemoteOpProgress updates when invoked attached.

    provider?: IMetadataProvider

    Explicit provider to route through. When omitted, the active default provider is used. The resolved provider also implements IRemoteOperationProvider (it is a ProviderBase).

    requestOrigin?: string

    Normalized HTTP Origin header from the inbound request (e.g. https://app.example.com), populated by the server transport when invoked over HTTP/GraphQL. Undefined for in-process server calls or requests without an Origin header.

    sessionId?: string

    Caller's authenticated session identifier, populated by the server transport when available.

    user?: UserInfo

    Server-side acting user. Supplied on the server; ignored on the client (set per session).

    Settings

    Member Visibility

    On This Page

    Properties