kkrpc
    Preparing search index...

    Module @kunkun/kkrpc

    kkrpc is a library for building RPC systems. This module is the main entrypoint of the library. It contains all core modules of the library.

    Exported modules includes

    • web worker
    • nodejs/bun
    • deno
    • websocket
    • http
    • hono-websocket
    • elysia-websocket
    • RPC Channel
    • serialization

    Optional adapters with peer dependencies (import separately):

    • kkrpc/rabbitmq - RabbitMQ adapter (requires amqplib)
    • kkrpc/kafka - Kafka adapter (requires kafkajs)
    • kkrpc/redis-streams - Redis Streams adapter (requires ioredis)
    • kkrpc/nats - NATS adapter (requires @nats-io/transport-node)
    • kkrpc/socketio - Socket.IO adapter (requires socket.io)

    If you want to use this library in browser, please use /browser instead.

    Namespaces

    StandardSchemaV1

    Classes

    BunIo
    DenoIo
    ElysiaWebSocketClientIO
    ElysiaWebSocketServerIO
    HTTPClientIO
    HTTPServerIO
    NodeIo
    RPCChannel
    RPCTimeoutError
    RPCValidationError
    TauriShellStdio
    WebSocketClientIO
    WebSocketServerIO
    WorkerChildIO
    WorkerParentIO

    Interfaces

    DefinedMethod
    EnhancedError
    HonoWebSocketOptions
    IoCapabilities
    IoInterface
    IoMessage
    Message
    MethodSchemaConfig
    MethodValidators
    Relay
    Response
    RPCCallContext
    SerializationOptions
    StandardSchemaV1
    TransferDescriptor
    TransferHandler
    TransferSlot
    WebSocketLike
    WireEnvelope

    Type Aliases

    ElysiaWebSocketIO
    EncodedMessage
    InferAPI
    RPCInterceptor
    RPCValidators
    WireFormat
    WireV1

    Variables

    TRANSFER_SLOT_PREFIX
    transferHandlers

    Functions

    createElysiaWebSocketClientIO
    createElysiaWebSocketIO
    createHonoWebSocketHandler
    createRelay
    decodeMessage
    defineAPI
    defineMethod
    deserializeError
    deserializeMessage
    encodeMessage
    extractValidators
    generateUUID
    hasTransferDescriptor
    isRPCTimeoutError
    isRPCValidationError
    lookupValidator
    processValueForTransfer
    reconstructValueFromTransfer
    registerTransferHandler
    runInterceptors
    runValidation
    serializeError
    serializeMessage
    takeTransferDescriptor
    transfer