Appearance

Connectum API Reference / @connectum/testing / index / createMockDescMethod

Function: createMockDescMethod() ​

createMockDescMethod(name, options?): DescMethod

Defined in: test-fixtures/dist/index.d.ts:236

Create a mock DescMethod descriptor.

When input or output are not provided, default mock messages are created automatically based on the method name (e.g. test.GetUserRequest / test.GetUserResponse).

Parameters ​

name ​

string

The RPC method name (PascalCase by convention).

options? ​

MockDescMethodOptions

Optional overrides for kind, input/output, and redaction.

Returns ​

DescMethod

A mock DescMethod object.

Example ​

ts
import { createMockDescMethod, createMockDescMessage } from "@connectum/testing";

const method = createMockDescMethod("GetUser");
// method.name       === "GetUser"
// method.localName  === "getUser"
// method.methodKind === "unary"

const streaming = createMockDescMethod("ListUsers", {
  kind: "server_streaming",
});