Type alias ProtocolParams

ProtocolParams: {
    host: string;
    path?: string;
    port: number;
    secure: boolean;
}

Type declaration

  • host: string

    The host to connect to. E.g., localhost or example.com.

  • Optional path?: string

    An optional path in the case that you are using a forwarding proxy.

    E.g., http://localhost:8080/weaviate

  • port: number

    The port to connect to. E.g., 8080 or 80.

  • secure: boolean

    Whether to use a secure connection (https).