better-grpc 0.2.3 → 0.2.4

package/README.md

@@ -95,6 +95,21 @@ import { createGrpcClient } from 'better-grpc';
 const client = await createGrpcClient('localhost:50051', myClientImpl);
 ```
 
+You can also override gRPC channel options (defaults are exported as `DEFAULT_OPTIONS`):
+
+```typescript
+import { createGrpcClient, DEFAULT_OPTIONS } from 'better-grpc';
+
+const client = await createGrpcClient(
+    'localhost:50051',
+    {
+        ...DEFAULT_OPTIONS,
+        'grpc.keepalive_time_ms': 15000,
+    },
+    myClientImpl
+);
+```
+
 ### 5. Make remote calls
 
 Now you can call remote functions from both the client and the server.
@@ -216,7 +231,11 @@ Creates and starts a gRPC server.
 
 - `createGrpcClient(address: string, ...services: ServiceImpl[])`
 
-Creates and starts a gRPC client.
+Creates and starts a gRPC client using `DEFAULT_OPTIONS`.
+
+- `createGrpcClient(address: string, options: ChannelOptions, ...services: ServiceImpl[])`
+
+Creates and starts a gRPC client with custom gRPC channel options. `DEFAULT_OPTIONS` is exported for easy overrides.
 
 ## Benchmarks
 

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { ChannelOptions } from 'nice-grpc';
 
 type Context<Meta extends z.ZodObject<any> | undefined> = {
     metadata: Meta extends z.ZodObject<any> ? z.infer<Meta> : undefined;
@@ -75,12 +76,16 @@ declare function Service<N extends string>(name: N): (abstract new () => {
 type ServiceNameOf<T extends ServiceImpl<any, any>> = T extends ServiceImpl<infer ServiceClass, any> ? InstanceType<ServiceClass>[typeof ServiceNameTag] : never;
 type ServiceCallable<T> = T extends ServiceImpl<infer S, infer Mode> ? Mode extends "server" ? ClientFn<InstanceType<S>> : ServerFn<InstanceType<S>, true, true> : never;
 
+declare const DEFAULT_OPTIONS: ChannelOptions;
 declare function createGrpcClient<T extends ServiceImpl<any, "client">[]>(address: string, ...serviceImpls: T): Promise<{
     [I in T[number] as ServiceNameOf<I>]: ServiceCallable<I>;
 }>;
+declare function createGrpcClient<T extends ServiceImpl<any, "client">[]>(address: string, grpcOptions: ChannelOptions, ...serviceImpls: T): Promise<{
+    [I in T[number] as ServiceNameOf<I>]: ServiceCallable<I>;
+}>;
 
 declare function createGrpcServer<T extends ServiceImpl<any, "server">[]>(port: number, ...serviceImpls: T): Promise<{
     [I in T[number] as ServiceNameOf<I>]: ServiceCallable<I>;
 }>;
 
-export { Service, bidi, client, createGrpcClient, createGrpcServer, server };
+export { DEFAULT_OPTIONS, Service, bidi, client, createGrpcClient, createGrpcServer, server };

package/dist/index.js

@@ -24220,19 +24220,13 @@ var GrpcClient = class {
   pendingBidi = /* @__PURE__ */ new Map();
   // bidi that is waiting for context
   pendingBidiAck = /* @__PURE__ */ new Map();
-  constructor(address, serviceImpls) {
+  constructor(address, grpcOptions, serviceImpls) {
     this.address = address;
     this.serviceImpls = serviceImpls;
     this.proto = loadProtoFromString(buildProtoString(serviceImpls));
     const useSSL = !address.includes("localhost") && !address.includes("127.0.0.1") && !address.includes("0.0.0.0");
     const credentials = useSSL ? ChannelCredentials.createSsl() : ChannelCredentials.createInsecure();
-    this.channel = createChannel(address, credentials, {
-      "grpc.max_receive_message_length": 10 * 1024 * 1024,
-      "grpc.max_send_message_length": 10 * 1024 * 1024,
-      "grpc.keepalive_time_ms": 3e4,
-      "grpc.keepalive_timeout_ms": 1e4,
-      "grpc.keepalive_permit_without_calls": 1
-    });
+    this.channel = createChannel(address, credentials, grpcOptions);
     this.clientFactory = createClientFactory();
   }
   start() {
@@ -24441,8 +24435,22 @@ var GrpcClient = class {
 };
 
 // src/runtime/grpc-client.ts
-async function createGrpcClient(address, ...serviceImpls) {
-  const grpcClientInstance = new GrpcClient(address, serviceImpls);
+var DEFAULT_OPTIONS = {
+  "grpc.max_receive_message_length": 10 * 1024 * 1024,
+  "grpc.max_send_message_length": 10 * 1024 * 1024,
+  "grpc.keepalive_time_ms": 3e4,
+  "grpc.keepalive_timeout_ms": 1e4,
+  "grpc.keepalive_permit_without_calls": 1,
+  "grpc.http2.max_pings_without_data": 0,
+  "grpc.http2.min_time_between_pings_ms": 1e4,
+  "grpc.http2.min_ping_interval_without_data_ms": 1e4
+};
+async function createGrpcClient(address, grpcOptionsOrServiceImpls, ...serviceImpls) {
+  const isServiceImpl = grpcOptionsOrServiceImpls instanceof Object && "type" in grpcOptionsOrServiceImpls && "serviceClass" in grpcOptionsOrServiceImpls;
+  const isChannelOptions = !isServiceImpl;
+  const grpcOptions = isChannelOptions ? grpcOptionsOrServiceImpls : DEFAULT_OPTIONS;
+  const allServiceImpls = isChannelOptions ? serviceImpls : [grpcOptionsOrServiceImpls, ...serviceImpls];
+  const grpcClientInstance = new GrpcClient(address, grpcOptions, allServiceImpls);
   grpcClientInstance.start();
   await grpcClientInstance.waitUntilReady();
   grpcClientInstance.watching();
@@ -24710,6 +24718,6 @@ long/umd/index.js:
    *)
 */
 
-export { Service, bidi, client, createGrpcClient, createGrpcServer, server };
+export { DEFAULT_OPTIONS, Service, bidi, client, createGrpcClient, createGrpcServer, server };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map