@parsrun/service 0.1.28 → 0.1.30

package/dist/client.d.ts

@@ -1,4 +1,4 @@
-import { b as ServiceDefinition, w as ServiceClientOptions, x as ServiceClient, S as ServiceConfig } from './types-n4LLSPQU.js';
+import { b as ServiceDefinition, w as ServiceClientOptions, x as ServiceClient, S as ServiceConfig } from './types-DHZaZwAt.js';
 
 /**
  * @parsrun/service - Service Client
@@ -28,7 +28,22 @@ import { b as ServiceDefinition, w as ServiceClientOptions, x as ServiceClient,
  */
 declare function useService<TDef extends ServiceDefinition = ServiceDefinition>(serviceName: string, options?: ServiceClientOptions): ServiceClient<TDef>;
 /**
- * Create a typed service client from a definition
+ * Create a typed service client from a service definition.
+ * Provides full type safety for queries, mutations, and events.
+ *
+ * @param definition - The service definition
+ * @param options - Client configuration options
+ * @returns A typed service client
+ *
+ * @example
+ * ```typescript
+ * const payments = useTypedService(paymentsServiceDefinition, {
+ *   mode: 'http',
+ *   baseUrl: 'https://payments.example.com',
+ * });
+ * // Full type safety for all operations
+ * const sub = await payments.query('getSubscription', { subscriptionId: '123' });
+ * ```
  */
 declare function useTypedService<TDef extends ServiceDefinition>(definition: TDef, options?: ServiceClientOptions): ServiceClient<TDef>;
 /**
@@ -48,7 +63,19 @@ declare class ServiceRegistry {
     closeAll(): Promise<void>;
 }
 /**
- * Create a service registry
+ * Create a service registry for managing multiple service clients.
+ *
+ * @param config - Optional shared configuration for all clients
+ * @returns A new service registry instance
+ *
+ * @example
+ * ```typescript
+ * const registry = createServiceRegistry({ tracing: { enabled: true } });
+ * const payments = registry.get('payments');
+ * const users = registry.get('users');
+ * // Later, clean up all connections
+ * await registry.closeAll();
+ * ```
  */
 declare function createServiceRegistry(config?: ServiceConfig): ServiceRegistry;
 

package/dist/client.js

@@ -440,6 +440,7 @@ function withRetry(fn, options) {
 
 // src/resilience/timeout.ts
 var TimeoutExceededError = class extends Error {
+  /** The timeout value in milliseconds that was exceeded */
   timeout;
   constructor(timeout) {
     super(`Operation timed out after ${timeout}ms`);