Interface ProtoRuntime

Readonly bin

Readonly json

Readonly syntax

Readonly util

getEnumType

• getEnumType(enumObject): EnumType

• Get reflection information - the EnumType - from an enum object. If this function is called on something other than a generated enum, or an enum constructed with makeEnum(), it raises an error.

  Parameters

  • enumObject: EnumObject

  Returns EnumType

makeEnum

• makeEnum(typeName, values, opt?): EnumObject

• Create an enum object at runtime, without generating code.

  The object conforms to TypeScript enums, and comes with mapping from name to value, and from value to name.

  The type name and other reflection information is accessible via getEnumType().

  Parameters

  • typeName: string

  • values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[]

  • Optional opt: {}

  Returns EnumObject

makeEnumType

• makeEnumType(typeName, values, opt?): EnumType

• Create an enum type at runtime, without generating code. Note that this only creates the reflection information, not an actual enum object.

  Parameters

  • typeName: string

  • values: (EnumValueInfo | Omit<EnumValueInfo, "localName">)[]

  • Optional opt: {}

  Returns EnumType

makeMessageType

• makeMessageType<T>(typeName, fields, opt?): MessageType<T>

• Create a message type at runtime, without generating code.

  Type Parameters

  • T extends Message<T> = AnyMessage

  Parameters

  • typeName: string

  • fields: FieldListSource

  • Optional opt: {
        localName?: string;
    }

    • Optional localName?: string

  Returns MessageType<T>