Skip to content

Main Navigation Guide Packages API

Migration & Changelog

Contributing

Examples

Appearance

Sidebar Navigation

@connectum/auth

Modules

proto

Type Aliases

AuthRequirements

MethodAuth

ServiceAuth

Variables

AuthRequirementsSchema

method_auth

MethodAuthSchema

service_auth

ServiceAuthSchema

testing

Interfaces

RsaTestKeypair

TestJwksServer

Variables

TEST_JWT_KID

TEST_JWT_SECRET

Functions

createMockAuthContext

createTestJwt

createTestJwtRS256

generateRsaTestKeypair

startTestJwksServer

withAuthContext

Classes

AuthzDeniedError

LruCache

Interfaces

AuthContext

AuthInterceptorOptions

AuthzDeniedDetails

AuthzInterceptorOptions

AuthzRule

CacheOptions

ClientBearerInterceptorOptions

ClientGatewayInterceptorOptions

GatewayAuthInterceptorOptions

GatewayHeaderMapping

InternalAuthInterceptorOptions

JwtAuthInterceptorOptions

MeshIdentityEntry

MeshIdentityTrustOptions

ProtoAuthzInterceptorOptions

ResolvedMethodAuth

SessionAuthInterceptorOptions

SharedSecretTrustOptions

SignedTokenIssuer

SignedTokenTrustOptions

Type Aliases

AuthzEffect

InterceptorFactory

InternalTrustSource

Variables

AUTH_HEADERS

authContextStorage

AuthzEffect

Functions

createAuthInterceptor

createAuthzInterceptor

createClientBearerInterceptor

createClientGatewayInterceptor

createGatewayAuthInterceptor

createInternalAuthInterceptor

createJwtAuthInterceptor

createProtoAuthzInterceptor

createSessionAuthInterceptor

getAuthContext

getInternalMethods

getPublicMethods

matchesMethodPattern

meshIdentityTrust

parseAuthHeaders

requireAuthContext

resolveMethodAuth

setAuthHeaders

sharedSecretTrust

signedTokenTrust

@connectum/cli

commands

proto-sync

Interfaces

ProtoSyncOptions

Variables

protoSyncCommand

Functions

executeProtoSync

utils

reflection

Interfaces

ReflectionResult

Functions

fetchFileDescriptorSetBinary

fetchReflectionData

@connectum/core

Modules

config

types

Interfaces

CreateServerOptions

EventBusLike

ProtocolContext

ProtocolRegistration

Server

ServerClientOptions

ShutdownOptions

TLSOptions

Type Aliases

HttpHandler

LifecycleEvent

NodeRequest

NodeResponse

ServerState

ShutdownHook

TransportServer

Variables

LifecycleEvent

ServerState

Classes

CatalogConfigError

TransportValidationError

Interfaces

BidiStreamHandle

CatalogClient

ClientStreamHandle

ConnectumCallMap

ConnectumStreamMap

Context

CreateCatalogClientOptions

CreateLocalTransportOptions

DnsResolverOptions

PerServiceEnvResolverOptions

ResolverContext

SanitizableError

ServiceDefinition

StreamingMethodInfo

Type Aliases

CallOptions

CatalogCall

CatalogStream

ConnectumEnv

ConnectumMethodImpl

ConnectumServiceImpl

EffectiveTransport

RemoteResolver

ServiceCatalog

ServiceOptions

StreamReturn

TransportValidationMode

Variables

BooleanFromStringSchema

ConnectumEnvSchema

defaultPropagateHeaders

EffectiveTransport

LogFormatSchema

LoggerBackendSchema

LogLevelSchema

NodeEnvSchema

tlsPath

TRANSPORT_VALIDATION_ERROR_CODE

TransportValidationMode

Functions

collectStreamingMethods

createCatalogClient

createLocalTransport

createServer

defineCatalog

defineLazyService

defineService

dnsResolver

getTLSPath

isSanitizableError

mapResolver

matchServicesPattern

mergeCatalogs

mergeEnabledServices

parseEnvConfig

parseServicesEnv

perServiceEnvResolver

readTLSCertificates

resolveEffectiveTransport

safeParseEnvConfig

singleTransportResolver

@connectum/events

Modules

types

Interfaces

AdapterContext

DlqOptions

EventAdapter

EventBus

EventBusOptions

EventContext

EventContextInit

EventHandlerConfig

EventRouteEntry

EventRouter

EventSubscription

MiddlewareConfig

PublishOptions

RawEvent

RawSubscribeOptions

RetryOptions

Type Aliases

EventAdapterFactory

EventMiddleware

EventMiddlewareNext

EventRoute

RawEventHandler

ServiceEventHandlers

TypedEventHandler

Classes

EventRouterImpl

NonRetryableError

RetryableError

Interfaces

BroadcastReactor

BroadcastSubscribersOptions

Functions

composeMiddleware

createBroadcastSubscribers

createEventBus

createEventContext

deriveServiceName

dlqMiddleware

matchPattern

MemoryAdapter

resolveTopicName

retryMiddleware

@connectum/events-amqp

Modules

testing

Interfaces

FakeAmqpAdapterInstance

FakeAmqpAdapterOptions

FakeAmqpControl

FakeDeliveryResult

FakePublishedRecord

Type Aliases

FakePublishOutcome

Functions

FakeAmqpAdapter

types

Interfaces

AmqpAdapterOptions

AmqpBindingDeclaration

AmqpConsumerOptions

AmqpExchangeDeclaration

AmqpExchangeOptions

AmqpLifecycleCallbacks

AmqpPublisherOptions

AmqpPublishRetryOptions

AmqpQueueDeclaration

AmqpQueueOptions

AmqpQueueOverride

AmqpRecoveryOptions

AmqpSerializationOptions

AmqpTopology

Type Aliases

AmqpLifecycleEvent

AmqpTopologyMode

Variables

AmqpTopologyMode

Classes

AmqpAdapterError

AmqpConnectionError

AmqpPublishNackError

AmqpPublishTimeoutError

AmqpSerializationError

AmqpTopologyError

AmqpUnroutableError

Type Aliases

AmqpTopologyObject

Functions

AmqpAdapter

isAutoRetriablePublishError

toAmqpPattern

@connectum/events-kafka

Modules

types

Interfaces

KafkaAdapterOptions

Functions

KafkaAdapter

@connectum/events-nats

Modules

types

Interfaces

NatsAdapterOptions

NatsConsumerOptions

Functions

NatsAdapter

@connectum/events-redis

Modules

types

Interfaces

RedisAdapterOptions

RedisBrokerOptions

Functions

RedisAdapter

@connectum/healthcheck

Classes

HealthcheckManager

Variables

healthcheckManager

Functions

createHealthcheckManager

createHttpHealthHandler

Healthcheck

parseServiceFromUrl

@connectum/healthcheck/types

Interfaces

HealthcheckOptions

ServiceStatus

Type Aliases

ServingStatus

Variables

ServingStatus

@connectum/interceptors

Modules

bulkhead

Functions

createBulkheadInterceptor

circuit-breaker

Functions

createCircuitBreakerInterceptor

defaultFailurePredicate

defaults

Interfaces

DefaultInterceptorOptions

Functions

createDefaultInterceptors

errorHandler

Functions

createErrorHandlerInterceptor

fallback

Functions

createFallbackInterceptor

logger

Functions

createLoggerInterceptor

method-filter

Functions

createMethodFilterInterceptor

retry

Functions

createRetryInterceptor

serializer

Functions

createSerializerInterceptor

timeout

Functions

createTimeoutInterceptor

Interfaces

BulkheadOptions

CircuitBreakerOptions

ErrorHandlerOptions

FallbackOptions

LoggerOptions

RetryOptions

SerializerOptions

TimeoutOptions

Type Aliases

InterceptorFactory

MethodFilterMap

@connectum/otel

Modules

attributes

Type Aliases

ConnectErrorCode

Variables

ATTR_CONNECTUM_TRANSPORT

ATTR_CONNECTUM_TRANSPORT_METRIC

ATTR_ERROR_TYPE

ATTR_NETWORK_PEER_ADDRESS

ATTR_NETWORK_PEER_PORT

ATTR_NETWORK_PROTOCOL_NAME

ATTR_NETWORK_TRANSPORT

ATTR_RPC_CONNECT_RPC_STATUS_CODE

ATTR_RPC_MESSAGE_ID

ATTR_RPC_MESSAGE_TYPE

ATTR_RPC_MESSAGE_UNCOMPRESSED_SIZE

ATTR_RPC_METHOD

ATTR_RPC_SERVICE

ATTR_RPC_SYSTEM

ATTR_SERVER_ADDRESS

ATTR_SERVER_PORT

ConnectErrorCode

ConnectErrorCodeName

CONNECTUM_INTERNAL_TRANSPORT_HEADER

CONNECTUM_INTERNAL_TRANSPORT_IN_PROCESS

RPC_MESSAGE_EVENT

RPC_SYSTEM_CONNECT_RPC

client-interceptor

Functions

createOtelClientInterceptor

interceptor

Functions

createOtelInterceptor

logger

Interfaces

Logger

LoggerOptions

Functions

getLogger

meter

Functions

getMeter

metrics

Interfaces

RpcClientMetrics

RpcServerMetrics

Functions

createRpcClientMetrics

createRpcServerMetrics

provider

Interfaces

ProviderOptions

ResourceAttributeInputs

Functions

buildResourceAttributes

getProvider

initProvider

parseOtelResourceAttributesEnv

shutdownProvider

shared

Interfaces

BaseAttributeParams

Functions

applyAttributeFilter

buildBaseAttributes

buildErrorAttributes

detectConnectumTransport

estimateMessageSize

wrapAsyncIterable

traceAll

Functions

traceAll

traced

Functions

traced

tracer

Functions

getTracer

Interfaces

BatchSpanProcessorOptions

CollectorOptions

Meter

OtelBaseOptions

OtelClientInterceptorOptions

OtelInterceptorOptions

OTLPSettings

TraceAllOptions

TracedOptions

Tracer

Type Aliases

ArgsFilter

ExporterType

MethodArgsFilter

OtelAttributeFilter

OtelFilter

Variables

ExporterType

Functions

getBatchSpanProcessorOptions

getCollectorOptions

getOTLPSettings

getServiceMetadata

@connectum/reflection

Functions

collectFileProtos

Reflection

@connectum/test-fixtures

index

Interfaces

MockCall

MockFn

Functions

assertConnectError

createFakeMethod

createFakeService

createMockDescField

createMockDescMessage

createMockDescMethod

createMockFn

createMockNext

createMockNextError

createMockNextSlow

createMockRequest

createMockStream

types

Interfaces

FakeMethodOptions

FakeServiceOptions

MockDescFieldOptions

MockDescMessageOptions

MockDescMethodOptions

MockNextOptions

MockRequestOptions

MockStreamOptions

@connectum/testing

index

Classes

InMemoryMetricCollector

InMemorySpanCollector

Interfaces

CreateMockContextOptions

FakeMethodOptions

FakeServiceOptions

MockCall

MockDescFieldOptions

MockDescMessageOptions

MockDescMethodOptions

MockFn

MockNextOptions

MockRequestOptions

MockService

MockStreamOptions

NormalizedMetric

NormalizedSpan

Variables

MOCK_RESPONSE_HEADER

TRANSPORT_METRIC_ATTRIBUTE

TRANSPORT_SPAN_ATTRIBUTE

Functions

assertConnectError

createFakeMethod

createFakeService

createLocalClient

createMockContext

createMockDescField

createMockDescMessage

createMockDescMethod

createMockFn

createMockNext

createMockNextError

createMockNextSlow

createMockRequest

createMockStream

createTestServer

mockResolver

mockService

withTestServer

types

Interfaces

CreateTestServerOptions

TestServer

On this page

Are you an LLM? You can read better optimized documentation at /en/api/@connectum/cli.md for this page in Markdown format

Connectum API Reference / @connectum/cli

@connectum/cli

Modules

commands/proto-sync
utils/reflection

Edit this page on GitHub

Pager

Previous pagesignedTokenTrust

Next pageproto-sync

Released under the Apache License 2.0. · llms.txt · llms-full.txt

Copyright Highload.Zone