FileDescription
FileDescription holds a map of all types and enum values declared within a proto file.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FileDescription(
nameValue,descValue,typesValue,enumsValue):FileDescription
Parameters
Section titled “Parameters”nameValue
Section titled “nameValue”string
descValue
Section titled “descValue”DescFile
typesValue
Section titled “typesValue”Map<string, TypeDescription>
enumsValue
Section titled “enumsValue”Map<string, EnumValueDescription>
Returns
Section titled “Returns”FileDescription
Methods
Section titled “Methods”copy()
Section titled “copy()”copy(
extensions):FileDescription
Copy creates a copy of the FileDescription with updated Db references within its types.
Parameters
Section titled “Parameters”extensions
Section titled “extensions”Returns
Section titled “Returns”FileDescription
fileDescriptor()
Section titled “fileDescriptor()”fileDescriptor():
DescFile
FileDescriptor returns the proto file descriptor associated with the file representation.
Returns
Section titled “Returns”DescFile
getEnumDescription()
Section titled “getEnumDescription()”getEnumDescription(
enumName): [EnumValueDescription|undefined,boolean]
GetEnumDescription returns an EnumDescription for a qualified enum value name declared within the file.
Parameters
Section titled “Parameters”enumName
Section titled “enumName”string
Returns
Section titled “Returns”[EnumValueDescription | undefined, boolean]
getEnumNames()
Section titled “getEnumNames()”getEnumNames():
string[]
GetEnumNames returns the string names of all enum values in the file.
Returns
Section titled “Returns”string[]
getName()
Section titled “getName()”getName():
string
GetName returns the fully qualified file path for the file.
Returns
Section titled “Returns”string
getTypeDescription()
Section titled “getTypeDescription()”getTypeDescription(
typeName): [TypeDescription|undefined,boolean]
GetTypeDescription returns a TypeDescription for a qualified protobuf message type name declared within the file.
Parameters
Section titled “Parameters”typeName
Section titled “typeName”string
Returns
Section titled “Returns”[TypeDescription | undefined, boolean]
getTypeNames()
Section titled “getTypeNames()”getTypeNames():
string[]
GetTypeNames returns the list of all type names contained within the file.
Returns
Section titled “Returns”string[]