JSDoc: Class: File

new File(opt_dataopt)

Generated by JsPbCodeGenerator.

Parameters:

Name	Type	Attributes	Description
`opt_data`	Array	<optional>	Optional initial data array, typically from a server response, or constructed directly in Javascript. The array is used in place and becomes part of the constructed object. It is not cloned. If no data is provided, the constructed object will be empty, but still valid.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 95

Extends

jspb.Message

Members

(static) displayName

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 104

Methods

clearContent() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Clears the field making it undefined.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1090

Returns:

returns this

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

clearInsertionPoint() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Clears the field making it undefined.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1054

Returns:

returns this

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

clearName() → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Clears the field making it undefined.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1018

Returns:

returns this

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

getContent() → {string}

optional string content = 15;

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1072

Returns:

Type: string

getInsertionPoint() → {string}

optional string insertion_point = 2;

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1036

Returns:

Type: string

getName() → {string}

optional string name = 1;

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1000

Returns:

Type: string

hasContent() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1099

Returns:

Type: boolean

hasInsertionPoint() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1063

Returns:

Type: boolean

hasName() → {boolean}

Returns whether this field is set.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1027

Returns:

Type: boolean

serializeBinary() → (non-null) {Uint8Array}

Serializes the message to binary data (in protobuf wire format).

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 956

Returns:

Type: Uint8Array

setContent(value) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1081

Returns:

returns this

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

setInsertionPoint(value) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1045

Returns:

returns this

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

setName(value) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Parameters:

Name	Type	Description
`value`	string

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 1009

Returns:

returns this

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

toObject(opt_includeInstanceopt) → (non-null) {Object}

Creates an object representation of this proto. Field names that are reserved in JavaScript and will be renamed to pb_name. Optional fields that are not set will be set to undefined. To access a reserved field use, foo.pb_, eg, foo.pb_default. For the list of reserved names please see: net/proto2/compiler/js/internal/generator.cc#kKeyword.

Parameters:

Name	Type	Attributes	Description
`opt_includeInstance`	boolean	<optional>	Deprecated. whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 876

Returns:

Type: Object

(static) deserializeBinary(bytes) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Deserializes binary data (in protobuf wire format).

Parameters:

Name	Type	Description
`bytes`	jspb.ByteSource	The bytes to deserialize.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 910

Returns:

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

(static) deserializeBinaryFromReader(msgnon-null, readernon-null) → (non-null) {proto.google.protobuf.compiler.CodeGeneratorResponse.File}

Deserializes binary data (in protobuf wire format) from the given reader into the given message object.

Parameters:

Name	Type	Description
`msg`	proto.google.protobuf.compiler.CodeGeneratorResponse.File	The message object to deserialize into.
`reader`	jspb.BinaryReader	The BinaryReader to use.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 924

Returns:

Type: proto.google.protobuf.compiler.CodeGeneratorResponse.File

(static) serializeBinaryToWriter(messagenon-null, writernon-null)

Serializes the given message to binary data (in protobuf wire format), writing to the given BinaryWriter.

Parameters:

Name	Type	Description
`message`	proto.google.protobuf.compiler.CodeGeneratorResponse.File
`writer`	jspb.BinaryWriter

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 970

(static) toObject(includeInstance, msgnon-null) → (non-null) {Object}

Static version of the {@see toObject} method.

Parameters:

Name	Type	Description
`includeInstance`	boolean \| undefined	Deprecated. Whether to include the JSPB instance for transitional soy proto support: http://goto/soy-param-migration
`msg`	proto.google.protobuf.compiler.CodeGeneratorResponse.File	The msg instance to transform.

Source:

proto/google/protobuf/compiler/plugin_pb.js, line 890

Returns:

Type: Object