Type alias ConnectToCustomOptions

ConnectToCustomOptions: {
    authCredentials?: AuthCredentials;
    grpcHost?: string;
    grpcPort?: number;
    grpcSecure?: boolean;
    headers?: Record<string, string>;
    httpHost?: string;
    httpPath?: string;
    httpPort?: number;
    httpSecure?: boolean;
    proxies?: ProxiesParams;
    skipInitChecks?: boolean;
    timeout?: TimeoutParams;
}

Type declaration

  • Optional authCredentials?: AuthCredentials

    The authentication credentials to use when connecting to Weaviate, e.g. API key

  • Optional grpcHost?: string

    The hostname of the HTTP/2 server

  • Optional grpcPort?: number

    The port of the HTTP/2 server

  • Optional grpcSecure?: boolean

    Whether to use a secure connection to the HTTP/2 server

  • Optional headers?: Record<string, string>

    Additional headers to include in the request

  • Optional httpHost?: string

    The hostname of the HTTP/1.1 server

  • Optional httpPath?: string

    An additional path of the HTTP/1.1 server, e.g. http://proxy.net/weaviate

  • Optional httpPort?: number

    The port of the HTTP/1.1 server

  • Optional httpSecure?: boolean

    Whether to use a secure connection to the HTTP/1.1 server

  • Optional proxies?: ProxiesParams

    The proxy configuration to use

  • Optional skipInitChecks?: boolean

    Whether to skip the initialization checks

  • Optional timeout?: TimeoutParams

    The timeouts to use when making requests to Weaviate

Settings

Member Visibility

Theme