Interface FieldList

Provides convenient access to field information of a message type.

interface FieldList {
    byMember(): readonly (OneofInfo | FieldInfo)[];
    byNumber(): readonly FieldInfo[];
    find(fieldNo): undefined | FieldInfo;
    findJsonName(jsonName): undefined | FieldInfo;
    list(): readonly FieldInfo[];
}

Methods

byMember byNumber find findJsonName list

Methods

byMember

  • byMember(): readonly (OneofInfo | FieldInfo)[]

  • In order of appearance in the source, list fields and oneof groups.

    Returns readonly (OneofInfo | FieldInfo)[]

byNumber

  • byNumber(): readonly FieldInfo[]

  • Return field information ordered by field number ascending.

    Returns readonly FieldInfo[]

find

  • find(fieldNo): undefined | FieldInfo

  • Find field information by proto field number.

    Parameters

    • fieldNo: number

    Returns undefined | FieldInfo

findJsonName

  • findJsonName(jsonName): undefined | FieldInfo

  • Find field information by field name or json_name.

    Parameters

    • jsonName: string

    Returns undefined | FieldInfo

list

  • list(): readonly FieldInfo[]

  • Return field information in the order they appear in the source.

    Returns readonly FieldInfo[]

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc