Interface MessageConnection

interface MessageConnection {
    onClose: Event<void>;
    onDispose: Event<void>;
    onError: Event<[Error, undefined | Message, undefined | number]>;
    onUnhandledNotification: Event<NotificationMessage>;
    onUnhandledProgress: Event<ProgressParams<any>>;
    dispose(): void;
    end(): void;
    hasPendingResponse(): boolean;
    inspect(): void;
    listen(): void;
    onNotification(
        type: NotificationType0,
        handler: NotificationHandler0,
    ): Disposable;
    onNotification<P>(
        type: NotificationType<P>,
        handler: NotificationHandler<P>,
    ): Disposable;
    onNotification<P1>(
        type: NotificationType1<P1>,
        handler: NotificationHandler1<P1>,
    ): Disposable;
    onNotification<P1, P2>(
        type: NotificationType2<P1, P2>,
        handler: NotificationHandler2<P1, P2>,
    ): Disposable;
    onNotification<P1, P2, P3>(
        type: NotificationType3<P1, P2, P3>,
        handler: NotificationHandler3<P1, P2, P3>,
    ): Disposable;
    onNotification<P1, P2, P3, P4>(
        type: NotificationType4<P1, P2, P3, P4>,
        handler: NotificationHandler4<P1, P2, P3, P4>,
    ): Disposable;
    onNotification<P1, P2, P3, P4, P5>(
        type: NotificationType5<P1, P2, P3, P4, P5>,
        handler: NotificationHandler5<P1, P2, P3, P4, P5>,
    ): Disposable;
    onNotification<P1, P2, P3, P4, P5, P6>(
        type: NotificationType6<P1, P2, P3, P4, P5, P6>,
        handler: NotificationHandler6<P1, P2, P3, P4, P5, P6>,
    ): Disposable;
    onNotification<P1, P2, P3, P4, P5, P6, P7>(
        type: NotificationType7<P1, P2, P3, P4, P5, P6, P7>,
        handler: NotificationHandler7<P1, P2, P3, P4, P5, P6, P7>,
    ): Disposable;
    onNotification<P1, P2, P3, P4, P5, P6, P7, P8>(
        type: NotificationType8<P1, P2, P3, P4, P5, P6, P7, P8>,
        handler: NotificationHandler8<P1, P2, P3, P4, P5, P6, P7, P8>,
    ): Disposable;
    onNotification<P1, P2, P3, P4, P5, P6, P7, P8, P9>(
        type: NotificationType9<P1, P2, P3, P4, P5, P6, P7, P8, P9>,
        handler: NotificationHandler9<P1, P2, P3, P4, P5, P6, P7, P8, P9>,
    ): Disposable;
    onNotification(
        method: string,
        handler: GenericNotificationHandler,
    ): Disposable;
    onNotification(handler: StarNotificationHandler): Disposable;
    onProgress<P>(
        type: ProgressType<P>,
        token: string | number,
        handler: NotificationHandler<P>,
    ): Disposable;
    onRequest<R, E>(
        type: RequestType0<R, E>,
        handler: RequestHandler0<R, E>,
    ): Disposable;
    onRequest<P, R, E>(
        type: RequestType<P, R, E>,
        handler: RequestHandler<P, R, E>,
    ): Disposable;
    onRequest<P1, R, E>(
        type: RequestType1<P1, R, E>,
        handler: RequestHandler1<P1, R, E>,
    ): Disposable;
    onRequest<P1, P2, R, E>(
        type: RequestType2<P1, P2, R, E>,
        handler: RequestHandler2<P1, P2, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, R, E>(
        type: RequestType3<P1, P2, P3, R, E>,
        handler: RequestHandler3<P1, P2, P3, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, P4, R, E>(
        type: RequestType4<P1, P2, P3, P4, R, E>,
        handler: RequestHandler4<P1, P2, P3, P4, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, P4, P5, R, E>(
        type: RequestType5<P1, P2, P3, P4, P5, R, E>,
        handler: RequestHandler5<P1, P2, P3, P4, P5, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, P4, P5, P6, R, E>(
        type: RequestType6<P1, P2, P3, P4, P5, P6, R, E>,
        handler: RequestHandler6<P1, P2, P3, P4, P5, P6, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, P4, P5, P6, P7, R, E>(
        type: RequestType7<P1, P2, P3, P4, P5, P6, P7, R, E>,
        handler: RequestHandler7<P1, P2, P3, P4, P5, P6, P7, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, P4, P5, P6, P7, P8, R, E>(
        type: RequestType8<P1, P2, P3, P4, P5, P6, P7, P8, R, E>,
        handler: RequestHandler8<P1, P2, P3, P4, P5, P6, P7, P8, R, E>,
    ): Disposable;
    onRequest<P1, P2, P3, P4, P5, P6, P7, P8, P9, R, E>(
        type: RequestType9<P1, P2, P3, P4, P5, P6, P7, P8, P9, R, E>,
        handler: RequestHandler9<P1, P2, P3, P4, P5, P6, P7, P8, P9, R, E>,
    ): Disposable;
    onRequest<R, E>(
        method: string,
        handler: GenericRequestHandler<R, E>,
    ): Disposable;
    onRequest(handler: StarRequestHandler): Disposable;
    sendNotification(type: NotificationType0): Promise<void>;
    sendNotification<P>(type: NotificationType<P>, params?: P): Promise<void>;
    sendNotification<P1>(type: NotificationType1<P1>, p1: P1): Promise<void>;
    sendNotification<P1, P2>(
        type: NotificationType2<P1, P2>,
        p1: P1,
        p2: P2,
    ): Promise<void>;
    sendNotification<P1, P2, P3>(
        type: NotificationType3<P1, P2, P3>,
        p1: P1,
        p2: P2,
        p3: P3,
    ): Promise<void>;
    sendNotification<P1, P2, P3, P4>(
        type: NotificationType4<P1, P2, P3, P4>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
    ): Promise<void>;
    sendNotification<P1, P2, P3, P4, P5>(
        type: NotificationType5<P1, P2, P3, P4, P5>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
    ): Promise<void>;
    sendNotification<P1, P2, P3, P4, P5, P6>(
        type: NotificationType6<P1, P2, P3, P4, P5, P6>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
    ): Promise<void>;
    sendNotification<P1, P2, P3, P4, P5, P6, P7>(
        type: NotificationType7<P1, P2, P3, P4, P5, P6, P7>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
    ): Promise<void>;
    sendNotification<P1, P2, P3, P4, P5, P6, P7, P8>(
        type: NotificationType8<P1, P2, P3, P4, P5, P6, P7, P8>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        p8: P8,
    ): Promise<void>;
    sendNotification<P1, P2, P3, P4, P5, P6, P7, P8, P9>(
        type: NotificationType9<P1, P2, P3, P4, P5, P6, P7, P8, P9>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        p8: P8,
        p9: P9,
    ): Promise<void>;
    sendNotification(method: string, r0?: any, ...rest: any[]): Promise<void>;
    sendProgress<P>(
        type: ProgressType<P>,
        token: string | number,
        value: P,
    ): Promise<void>;
    sendRequest<R, E>(
        type: RequestType0<R, E>,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P, R, E>(
        type: RequestType<P, R, E>,
        params: P,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, R, E>(
        type: RequestType1<P1, R, E>,
        p1: P1,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, R, E>(
        type: RequestType2<P1, P2, R, E>,
        p1: P1,
        p2: P2,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, R, E>(
        type: RequestType3<P1, P2, P3, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, P4, R, E>(
        type: RequestType4<P1, P2, P3, P4, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, P4, P5, R, E>(
        type: RequestType5<P1, P2, P3, P4, P5, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, P4, P5, P6, R, E>(
        type: RequestType6<P1, P2, P3, P4, P5, P6, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, P4, P5, P6, P7, R, E>(
        type: RequestType7<P1, P2, P3, P4, P5, P6, P7, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, P4, P5, P6, P7, P8, R, E>(
        type: RequestType8<P1, P2, P3, P4, P5, P6, P7, P8, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        p8: P8,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<P1, P2, P3, P4, P5, P6, P7, P8, P9, R, E>(
        type: RequestType9<P1, P2, P3, P4, P5, P6, P7, P8, P9, R, E>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        p8: P8,
        p9: P9,
        token?: CancellationToken,
    ): Promise<R>;
    sendRequest<R>(method: string, r0?: any, ...rest: any[]): Promise<R>;
    trace(
        value: Trace,
        tracer: Tracer,
        sendNotification?: boolean,
    ): Promise<void>;
    trace(
        value: Trace,
        tracer: Tracer,
        traceOptions?: TraceOptions,
    ): Promise<void>;
}

Properties

onClose onDispose onError onUnhandledNotification onUnhandledProgress

Methods

dispose end hasPendingResponse inspect listen onNotification onProgress onRequest sendNotification sendProgress sendRequest trace

Properties

onClose

onClose: Event<void>

onDispose

onDispose: Event<void>

onError

onError: Event<[Error, undefined | Message, undefined | number]>

onUnhandledNotification

onUnhandledNotification: Event<NotificationMessage>

onUnhandledProgress

onUnhandledProgress: Event<ProgressParams<any>>

Methods

dispose

  • dispose(): void

  • Returns void

end

  • end(): void

  • Returns void

hasPendingResponse

  • hasPendingResponse(): boolean

  • Returns boolean

inspect

  • inspect(): void

  • Returns void

listen

  • listen(): void

  • Returns void

onNotification

onProgress

onRequest

sendNotification

  • sendNotification(type: NotificationType0): Promise<void>

  • Parameters

    Returns Promise<void>

  • sendNotification<P>(type: NotificationType<P>, params?: P): Promise<void>

  • Type Parameters

    • P

    Parameters

    Returns Promise<void>

  • sendNotification<P1>(type: NotificationType1<P1>, p1: P1): Promise<void>

  • Type Parameters

    • P1

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2>(
        type: NotificationType2<P1, P2>,
        p1: P1,
        p2: P2,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3>(
        type: NotificationType3<P1, P2, P3>,
        p1: P1,
        p2: P2,
        p3: P3,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3, P4>(
        type: NotificationType4<P1, P2, P3, P4>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3
    • P4

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3, P4, P5>(
        type: NotificationType5<P1, P2, P3, P4, P5>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3
    • P4
    • P5

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3, P4, P5, P6>(
        type: NotificationType6<P1, P2, P3, P4, P5, P6>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3
    • P4
    • P5
    • P6

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3, P4, P5, P6, P7>(
        type: NotificationType7<P1, P2, P3, P4, P5, P6, P7>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3
    • P4
    • P5
    • P6
    • P7

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3, P4, P5, P6, P7, P8>(
        type: NotificationType8<P1, P2, P3, P4, P5, P6, P7, P8>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        p8: P8,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3
    • P4
    • P5
    • P6
    • P7
    • P8

    Parameters

    Returns Promise<void>

  • sendNotification<P1, P2, P3, P4, P5, P6, P7, P8, P9>(
        type: NotificationType9<P1, P2, P3, P4, P5, P6, P7, P8, P9>,
        p1: P1,
        p2: P2,
        p3: P3,
        p4: P4,
        p5: P5,
        p6: P6,
        p7: P7,
        p8: P8,
        p9: P9,
    ): Promise<void>

  • Type Parameters

    • P1
    • P2
    • P3
    • P4
    • P5
    • P6
    • P7
    • P8
    • P9

    Parameters

    Returns Promise<void>

  • sendNotification(method: string, r0?: any, ...rest: any[]): Promise<void>

  • Parameters

    • method: string
    • Optionalr0: any
    • ...rest: any[]

    Returns Promise<void>

sendProgress

  • sendProgress<P>(
        type: ProgressType<P>,
        token: string | number,
        value: P,
    ): Promise<void>

  • Type Parameters

    • P

    Parameters

    Returns Promise<void>

sendRequest

trace

  • trace(value: Trace, tracer: Tracer, sendNotification?: boolean): Promise<void>

  • Parameters

    • value: Trace
    • tracer: Tracer
    • OptionalsendNotification: boolean

    Returns Promise<void>

  • trace(value: Trace, tracer: Tracer, traceOptions?: TraceOptions): Promise<void>

  • Parameters

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods