Skip to main content

Class: FileDescriptorProto

google.protobuf.FileDescriptorProto

Represents a FileDescriptorProto.

Implements

Constructors

constructor

new FileDescriptorProto(properties?): FileDescriptorProto

Constructs a new FileDescriptorProto.

Parameters

NameTypeDescription
properties?IFileDescriptorProtoProperties to set

Returns

FileDescriptorProto

Properties

dependency

dependency: string[]

FileDescriptorProto dependency.

Implementation of

IFileDescriptorProto.dependency


enumType

enumType: IEnumDescriptorProto[]

FileDescriptorProto enumType.

Implementation of

IFileDescriptorProto.enumType


extension

extension: IFieldDescriptorProto[]

FileDescriptorProto extension.

Implementation of

IFileDescriptorProto.extension


messageType

messageType: IDescriptorProto[]

FileDescriptorProto messageType.

Implementation of

IFileDescriptorProto.messageType


name

name: string

FileDescriptorProto name.

Implementation of

IFileDescriptorProto.name


options

Optional options: null | IFileOptions

FileDescriptorProto options.

Implementation of

IFileDescriptorProto.options


package

package: string

FileDescriptorProto package.

Implementation of

IFileDescriptorProto.package


publicDependency

publicDependency: number[]

FileDescriptorProto publicDependency.

Implementation of

IFileDescriptorProto.publicDependency


service

service: IServiceDescriptorProto[]

FileDescriptorProto service.

Implementation of

IFileDescriptorProto.service


sourceCodeInfo

Optional sourceCodeInfo: null | ISourceCodeInfo

FileDescriptorProto sourceCodeInfo.

Implementation of

IFileDescriptorProto.sourceCodeInfo


syntax

syntax: string

FileDescriptorProto syntax.

Implementation of

IFileDescriptorProto.syntax


weakDependency

weakDependency: number[]

FileDescriptorProto weakDependency.

Implementation of

IFileDescriptorProto.weakDependency

Methods

toJSON

toJSON(): Object

Converts this FileDescriptorProto to JSON.

Returns

Object

JSON object


create

create(properties?): FileDescriptorProto

Creates a new FileDescriptorProto instance using the specified properties.

Parameters

NameTypeDescription
properties?IFileDescriptorProtoProperties to set

Returns

FileDescriptorProto

FileDescriptorProto instance


decode

decode(reader, length?): FileDescriptorProto

Decodes a FileDescriptorProto message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

FileDescriptorProto

FileDescriptorProto

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): FileDescriptorProto

Decodes a FileDescriptorProto message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

FileDescriptorProto

FileDescriptorProto

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified FileDescriptorProto message. Does not implicitly google.protobuf.FileDescriptorProto.verify|verify messages.

Parameters

NameTypeDescription
messageIFileDescriptorProtoFileDescriptorProto message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified FileDescriptorProto message, length delimited. Does not implicitly google.protobuf.FileDescriptorProto.verify|verify messages.

Parameters

NameTypeDescription
messageIFileDescriptorProtoFileDescriptorProto message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): FileDescriptorProto

Creates a FileDescriptorProto message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

FileDescriptorProto

FileDescriptorProto


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for FileDescriptorProto

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

Creates a plain object from a FileDescriptorProto message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageFileDescriptorProtoFileDescriptorProto
options?IConversionOptionsConversion options

Returns

Object

Plain object