Connectum API Reference / @connectum/test-fixtures / types / MockDescMessageOptions

Interface: MockDescMessageOptions

Defined in: types.ts:71

Options for createMockDescMessage.

Properties

fields?

optional fields?: object[]

Defined in: types.ts:81

Field definitions. Default: []

name is the field name as written in the .proto file; localName is derived from it (user_id gives userId). fieldNumber defaults to the highest number used so far plus one; a repeated number throws, and so does a number outside 1 to 536870911 or inside the reserved range 19000 to 19999. type is a MockScalarType; any other value throws.

fieldNumber?

optional fieldNumber?: number

isSensitive?

optional isSensitive?: boolean

Mark the field as sensitive, as in MockDescFieldOptions.isSensitive. Default: false

name

name: string

type?

optional type?: MockScalarType

---

oneofs?

optional oneofs?: string[]

Defined in: types.ts:89

Oneof group names. A mock oneof group has no fields. Default: []