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

Function: createMockDescField()

createMockDescField(localName, options?): DescField

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

Create a mock DescField descriptor.

Produces a minimal object that satisfies the DescField shape expected by ConnectRPC interceptors and protobuf utilities.

Parameters

localName

string

The field's local (camelCase) name.

options?

MockDescFieldOptions

Optional overrides for field number, scalar type, and sensitivity.

Returns

DescField

A mock DescField object.

Example

import { createMockDescField } from "@connectum/testing";

const field = createMockDescField("userId", { type: "int32", fieldNumber: 1 });
// field.localName === "userId"
// field.scalar    === 5  (INT32)