1. Referensi API
  2. @samveys/grpc

@samveys/grpc

gRPC, gRPC-Web dan protokol Connect dari satu definisi service

Versi
1.0.35 Nov 2026
Pasang
pnpm add @samveys/grpc
Dokumentasi
README paket ini

Daftar ini dibaca dari versi 1.0.2; jalankan pnpm sync untuk memperbaruinya.

Import 
import { grpc, GreetRequestSchema, GreetResponseSchema, GreetService } from '@samveys/grpc'

Fungsi (1)

grpc Fungsi

The `@samveys/grpc` plugin: serves your Connect services over the Connect protocol and gRPC-Web on the app's HTTP port, and over native gRPC on an HTTP/2 port when `http2Port` is set.

function grpc(options: GrpcOptions): import("@samveys/core").Plugin<GrpcOptions>;

Diekspor dari packages/grpc/src/plugin.ts

Nilai (3)

GreetRequestSchema Nilai

Tidak ada komentar dokumentasi.

const GreetRequestSchema: GenMessage<GreetRequest>;

Diekspor dari packages/grpc/src/example.ts

GreetResponseSchema Nilai

Tidak ada komentar dokumentasi.

const GreetResponseSchema: GenMessage<GreetResponse>;

Diekspor dari packages/grpc/src/example.ts

GreetService Nilai

`samveys.example.v1.GreetService` with one unary method, `Greet`.

const GreetService: GenService<{
    greet: {
        methodKind: 'unary';
        input: typeof GreetRequestSchema;
        output: typeof GreetResponseSchema;
    };
}>;

Diekspor dari packages/grpc/src/example.ts

Interface (2)

GrpcOptions Interface

Public contracts of `@samveys/grpc`.

interface GrpcOptions extends Omit<ConnectRouterOptions, 'grpc' | 'grpcWeb' | 'connect'> {
    /** Register services: `(router) => router.service(GreetService, impl)`. */

Diekspor dari packages/grpc/src/contracts.ts

GrpcServer Interface

The `'grpc'` container binding.

interface GrpcServer {
    /** Paths served on the app's HTTP port, e.g. `/samveys.example.v1.GreetService/Greet`. */
    readonly paths: readonly string[];
    /** Address of the HTTP/2 gRPC listener; `undefined` without `http2Port` or before the app has started. */
    http2Address(): AddressInfo | undefined;
}

Diekspor dari packages/grpc/src/contracts.ts

Tipe (2)

GreetRequest Tipe

A sample service, written without protoc: the `FileDescriptorProto` of this schema is embedded as base64 and turned into descriptors by the `@bufbuild/protobuf` v2 runtime. ```proto syntax = "proto3"; package samveys.example.v1; message GreetRequest { string name = 1; } message GreetResponse { string greeting = 1; } service GreetService { rpc Greet(GreetRequest) returns (GreetResponse); } ```

type GreetRequest = Message<'samveys.example.v1.GreetRequest'> & {
    name: string;
};

Diekspor dari packages/grpc/src/example.ts

GreetResponse Tipe

Tidak ada komentar dokumentasi.

type GreetResponse = Message<'samveys.example.v1.GreetResponse'> & {
    greeting: string;
};

Diekspor dari packages/grpc/src/example.ts