Logo for jsDocs.io

@improbable-eng/grpc-web

  • Version 0.15.0
  • Published
  • 65.7 kB
  • 1 dependency
  • Apache-2.0 license

Install

npm i @improbable-eng/grpc-web
yarn add @improbable-eng/grpc-web
pnpm add @improbable-eng/grpc-web

Overview

gRPC-Web client for browsers (JS/TS)

Index

Namespaces

Namespaces

namespace grpc

namespace grpc {}

    variable CrossBrowserHttpTransport

    const CrossBrowserHttpTransport: (
        init: impTransportHttp.CrossBrowserHttpTransportInit
    ) => impTransport.TransportFactory;

      variable FetchReadableStreamTransport

      const FetchReadableStreamTransport: (
          init: impTransportFetch.FetchTransportInit
      ) => impTransport.TransportFactory;

        variable invoke

        const invoke: <
            TRequest extends impMessage.ProtobufMessage,
            TResponse extends impMessage.ProtobufMessage,
            M extends impService.MethodDefinition<TRequest, TResponse>
        >(
            methodDescriptor: M,
            props: impInvoke.InvokeRpcOptions<TRequest, TResponse>
        ) => impInvoke.Request;

          variable setDefaultTransport

          const setDefaultTransport: (t: impTransport.TransportFactory) => void;

            variable unary

            const unary: <
                TRequest extends impMessage.ProtobufMessage,
                TResponse extends impMessage.ProtobufMessage,
                M extends impService.UnaryMethodDefinition<TRequest, TResponse>
            >(
                methodDescriptor: M,
                props: impUnary.UnaryRpcOptions<TRequest, TResponse>
            ) => impInvoke.Request;

              variable WebsocketTransport

              const WebsocketTransport: () => impTransport.TransportFactory;

                variable XhrTransport

                const XhrTransport: (
                    init: impTransportXhr.XhrTransportInit
                ) => impTransport.TransportFactory;

                  function client

                  client: <
                      TRequest extends ProtobufMessage,
                      TResponse extends ProtobufMessage,
                      M extends MethodDefinition<TRequest, TResponse>
                  >(
                      methodDescriptor: M,
                      props: ClientRpcOptions
                  ) => Client<TRequest, TResponse>;

                    interface Client

                    interface Client<TRequest extends ProtobufMessage, TResponse extends ProtobufMessage>
                        extends impClient.Client<TRequest, TResponse> {}

                      interface ClientRpcOptions

                      interface ClientRpcOptions extends impClient.ClientRpcOptions {}

                        interface CrossBrowserHttpTransportInit

                        interface CrossBrowserHttpTransportInit
                            extends impTransportHttp.CrossBrowserHttpTransportInit {}

                          interface FetchReadableStreamInit

                          interface FetchReadableStreamInit extends impTransportFetch.FetchTransportInit {}

                            interface InvokeRpcOptions

                            interface InvokeRpcOptions<
                                TRequest extends ProtobufMessage,
                                TResponse extends ProtobufMessage
                            > extends impInvoke.InvokeRpcOptions<TRequest, TResponse> {}

                              interface MethodDefinition

                              interface MethodDefinition<
                                  TRequest extends ProtobufMessage,
                                  TResponse extends ProtobufMessage
                              > extends impService.MethodDefinition<TRequest, TResponse> {}

                                interface ProtobufMessage

                                interface ProtobufMessage extends impMessage.ProtobufMessage {}

                                  interface ProtobufMessageClass

                                  interface ProtobufMessageClass<T extends ProtobufMessage>
                                      extends impMessage.ProtobufMessageClass<T> {}

                                    interface Request

                                    interface Request extends impInvoke.Request {}

                                      interface RpcOptions

                                      interface RpcOptions extends impClient.RpcOptions {}

                                        interface ServiceDefinition

                                        interface ServiceDefinition extends impService.ServiceDefinition {}

                                          interface Transport

                                          interface Transport extends impTransport.Transport {}

                                            interface TransportFactory

                                            interface TransportFactory extends impTransport.TransportFactory {}

                                              interface TransportOptions

                                              interface TransportOptions extends impTransport.TransportOptions {}

                                                interface UnaryMethodDefinition

                                                interface UnaryMethodDefinition<
                                                    TRequest extends ProtobufMessage,
                                                    TResponse extends ProtobufMessage
                                                > extends impService.UnaryMethodDefinition<TRequest, TResponse> {}

                                                  interface UnaryOutput

                                                  interface UnaryOutput<TResponse extends ProtobufMessage>
                                                      extends impUnary.UnaryOutput<TResponse> {}

                                                    interface UnaryRpcOptions

                                                    interface UnaryRpcOptions<
                                                        TRequest extends ProtobufMessage,
                                                        TResponse extends ProtobufMessage
                                                    > extends impUnary.UnaryRpcOptions<TRequest, TResponse> {}

                                                      interface XhrTransportInit

                                                      interface XhrTransportInit extends impTransportXhr.XhrTransportInit {}

                                                        Package Files (1)

                                                        Dependencies (1)

                                                        Dev Dependencies (7)

                                                        Peer Dependencies (1)

                                                        Badge

                                                        To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                        You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@improbable-eng/grpc-web.

                                                        • Markdown
                                                          [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@improbable-eng/grpc-web)
                                                        • HTML
                                                          <a href="https://www.jsdocs.io/package/@improbable-eng/grpc-web"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>