modal-ts
    Preparing search index...

    Interface Tunnel

    A port forwarded from within a running Modal Sandbox.

    interface Tunnel {
        host: string;
        port: number;
        unencryptedHost?: string;
        unencryptedPort?: number;
        get tcpSocket(): [string, number];
        get tlsSocket(): [string, number];
        get url(): string;
    }
    Index

    Properties

    host port unencryptedHost? unencryptedPort?

    Accessors

    tcpSocket tlsSocket url

    Properties

    host: string
    port: number
    unencryptedHost?: string
    unencryptedPort?: number

    Accessors

    • get tcpSocket(): [string, number]

      Get the public TCP socket as a [host, port] tuple.

      Returns [string, number]

    • get tlsSocket(): [string, number]

      Get the public TLS socket as a [host, port] tuple.

      Returns [string, number]

    • get url(): string

      Get the public HTTPS URL of the forwarded port.

      Returns string

    Settings

    Member Visibility

    On This Page

    Properties
    Accessors