Connectum API Reference / @connectum/interceptors / timeout / createTimeoutInterceptor

Function: createTimeoutInterceptor()

createTimeoutInterceptor(options?): Interceptor

Defined in: timeout.ts:55

Create timeout interceptor

Prevents requests from hanging indefinitely by enforcing a timeout. Requests that exceed the timeout are cancelled and throw DeadlineExceeded error.

Parameters

options?

TimeoutOptions = {}

Timeout options

Returns

Interceptor

ConnectRPC interceptor

Examples

import { createServer } from '@connectum/core';
import { createTimeoutInterceptor } from '@connectum/interceptors';
import { myRoutes } from './routes.js';

const server = createServer({
  services: [myRoutes],
  interceptors: [
    createTimeoutInterceptor({
      duration: 30000,      // 30 second timeout
      skipStreaming: true,  // Skip streaming calls
    }),
  ],
});

await server.start();

import { createConnectTransport } from '@connectrpc/connect-node';
import { createTimeoutInterceptor } from '@connectum/interceptors';

const transport = createConnectTransport({
  baseUrl: 'http://localhost:5000',
  interceptors: [
    createTimeoutInterceptor({ duration: 10000 }),
  ],
});