Interface fiMap

interface fiMap {
    K: INT64 | UINT64 | INT32 | FIXED64 | FIXED32 | BOOL | STRING | UINT32 | SFIXED32 | SFIXED64 | SINT32 | SINT64;
    V: {
        T: ScalarType;
        kind: "scalar";
    } | {
        T: EnumType;
        kind: "enum";
    } | {
        T: MessageType<AnyMessage>;
        kind: "message";
    };
    default: undefined;
    delimited?: undefined;
    jsonName: string;
    kind: "map";
    localName: string;
    name: string;
    no: number;
    oneof?: OneofInfo;
    packed: false;
    repeated: false;
}

Hierarchy (view full)

Properties

K V default delimited? jsonName kind localName name no oneof? packed repeated

Properties

Readonly K

K: INT64 | UINT64 | INT32 | FIXED64 | FIXED32 | BOOL | STRING | UINT32 | SFIXED32 | SFIXED64 | SINT32 | SINT64

Map key type.

The key_type can be any integral or string type (so, any scalar type except for floating point types and bytes)

Readonly V

V: {
    T: ScalarType;
    kind: "scalar";
} | {
    T: EnumType;
    kind: "enum";
} | {
    T: MessageType<AnyMessage>;
    kind: "message";
}

Map value type. Can be scalar, enum, or message.

Type declaration

Type declaration

  • Readonly T: EnumType
  • Readonly kind: "enum"

Type declaration

Readonly default

default: undefined

An explicit default value (only proto2). Never set for maps.

Optional Readonly delimited

delimited?: undefined

Serialize this message with the delimited format, also known as group encoding, as opposed to the standard length prefix.

Only valid for message fields.

Readonly jsonName

jsonName: string

The name for JSON serialization / deserialization.

Readonly kind

kind: "map"

Readonly localName

localName: string

The name of the field as used in generated code.

Readonly name

name: string

The original name of the .proto field.

Readonly no

no: number

The field number of the .proto field.

Optional Readonly oneof

oneof?: OneofInfo

The oneof group, if this field belongs to one.

Readonly packed

packed: false

Is this repeated field packed? Never true for maps.

Readonly repeated

repeated: false

Is the field repeated? Never true for maps.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc