protobuf.js

API documentation

Top Level static
Namespaces
converter static
- fromObject
- toObject
rpc static
- ServiceMethod
- ServiceMethodCallback
types static
- basic
- defaults
- long
- mapKey
- packed
util static
- Array
- Buffer
- Long
- decorateRoot
- emptyArray
- emptyObject
- fs
- global
- isNode
- key2Re
- key32Re
- key64Re
- nestingLimit
- recursionLimit
- toJSONOptions
- asPromise
- boolFromKey
- camelCase
- codegen
- codegen
- compareFieldsById
- decorateEnum
- decorateType
- fetch
- fetch
- fetch
- isInteger
- isObject
- isReserved
- isSet
- isString
- isUnsafeProperty
- isset
- jsonName
- lcFirst
- longFromHash
- longFromKey
- longToHash
- makeProp
- merge
- newBuffer
- newError
- oneOfGetter
- oneOfSetter
- pool
- remove
- safeProp
- setProperty
- toArray
- toObject
- ucFirst
util.base64 static
- decode
- encode
- length
- test
util.float static
- readDoubleBE
- readDoubleLE
- readFloatBE
- readFloatLE
- writeDoubleBE
- writeDoubleLE
- writeFloatBE
- writeFloatLE
util.path static
- isAbsolute
- normalize
- resolve
util.utf8 static
- length
- read
- readStrict
- write
Classes
BufferReader
- buf
- discardUnknown
- len
- pos
- bool
- bytes
- double
- fixed32
- fixed64
- float
- int32
- int64
- raw
- sfixed32
- sfixed64
- sint32
- sint64
- skip
- skipType
- string
- stringVerify
- tag
- uint32
- uint64
BufferWriter
- head
- len
- states
- tail
- bool
- bytes
- double
- finish
- finishInto
- fixed32
- fixed64
- float
- fork
- int32
- int64
- ldelim
- raw
- reset
- sfixed32
- sfixed64
- sint32
- sint64
- string
- uint32
- uint64
- alloc
Enum
- comment
- comments
- filename
- fullName
- name
- options
- parent
- parsedOptions
- reserved
- resolved
- root
- values
- valuesById
- valuesOptions
- add
- getOption
- isReservedId
- isReservedName
- onAdd
- onRemove
- remove
- resolve
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
- fromJSON
Field
- bytes
- comment
- declaringField
- defaultValue
- delimited
- extend
- extensionField
- filename
- fullName
- hasPresence
- id
- jsonName
- long
- map
- message
- name
- optional
- options
- packed
- parent
- parsedOptions
- partOf
- protoName
- repeated
- required
- resolved
- resolvedType
- root
- rule
- type
- typeDefault
- getOption
- onAdd
- onRemove
- resolve
- setOptions
- setParsedOption
- toJSON
- toString
- d
- d
- fromJSON
FieldBase
- bytes
- comment
- declaringField
- defaultValue
- extend
- extensionField
- filename
- fullName
- id
- jsonName
- long
- map
- message
- name
- options
- parent
- parsedOptions
- partOf
- protoName
- repeated
- resolved
- resolvedType
- root
- rule
- type
- typeDefault
- getOption
- onAdd
- onRemove
- resolve
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
MapField
- bytes
- comment
- declaringField
- defaultValue
- extend
- extensionField
- filename
- fullName
- id
- jsonName
- keyType
- long
- map
- message
- name
- options
- parent
- parsedOptions
- partOf
- protoName
- repeated
- resolved
- resolvedKeyType
- resolvedType
- root
- rule
- type
- typeDefault
- getOption
- onAdd
- onRemove
- resolve
- setOptions
- setParsedOption
- toJSON
- toString
- d
- fromJSON
Message
- $type
- $type
- toJSON
- create
- decode
- decodeDelimited
- encode
- encodeDelimited
- fromObject
- toObject
- verify
Method
- comment
- filename
- fullName
- name
- options
- parent
- parsedOptions
- path
- requestStream
- requestType
- resolved
- resolvedRequestType
- resolvedResponseType
- responseStream
- responseType
- root
- type
- getOption
- onAdd
- onRemove
- resolve
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
- fromJSON
Namespace
- comment
- filename
- fullName
- name
- nested
- nestedArray
- options
- parent
- parsedOptions
- resolved
- root
- add
- addJSON
- define
- get
- getEnum
- getOption
- lookup
- lookup
- lookupEnum
- lookupService
- lookupType
- lookupTypeOrEnum
- onAdd
- onRemove
- remove
- resolve
- resolveAll
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
- arrayToJSON
- fromJSON
- isReservedId
- isReservedName
NamespaceBase
- comment
- filename
- fullName
- name
- nested
- nestedArray
- options
- parent
- parsedOptions
- resolved
- root
- add
- addJSON
- define
- get
- getEnum
- getOption
- lookup
- lookup
- lookupEnum
- lookupService
- lookupType
- lookupTypeOrEnum
- onAdd
- onRemove
- remove
- resolve
- resolveAll
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
OneOf
- comment
- fieldsArray
- filename
- fullName
- isProto3Optional
- name
- oneof
- options
- parent
- parsedOptions
- resolved
- root
- add
- getOption
- onAdd
- onRemove
- remove
- resolve
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
- d
- fromJSON
Reader
- buf
- discardUnknown
- len
- pos
- discardUnknown
- recursionLimit
- bool
- bytes
- double
- fixed32
- fixed64
- float
- int32
- int64
- raw
- sfixed32
- sfixed64
- sint32
- sint64
- skip
- skipType
- string
- stringVerify
- tag
- uint32
- uint64
- create
ReflectionObject
- comment
- filename
- fullName
- name
- options
- parent
- parsedOptions
- resolved
- root
- getOption
- onAdd
- onRemove
- resolve
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
Root
- comment
- deferred
- filename
- files
- fullName
- name
- nested
- nestedArray
- options
- parent
- parsedOptions
- resolved
- root
- add
- addJSON
- define
- fetch
- get
- getEnum
- getOption
- load
- load
- load
- loadSync
- lookup
- lookup
- lookupEnum
- lookupService
- lookupType
- lookupTypeOrEnum
- onAdd
- onRemove
- remove
- resolve
- resolveAll
- resolvePath
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
- fromJSON
Service
- comment
- filename
- fullName
- methods
- methodsArray
- name
- nested
- nestedArray
- options
- parent
- parsedOptions
- resolved
- root
- add
- addJSON
- create
- define
- get
- getEnum
- getOption
- lookup
- lookup
- lookupEnum
- lookupService
- lookupType
- lookupTypeOrEnum
- onAdd
- onRemove
- remove
- resolve
- resolveAll
- setOption
- setOptions
- setParsedOption
- toJSON
- toString
- fromJSON
Type
- comment
- ctor
- extensions
- fields
- fieldsArray
- fieldsById
- filename
- fullName
- name
- nested
- nestedArray
- oneofs
- oneofsArray
- options
- parent
- parsedOptions
- reserved
- resolved
- root
- add
- addJSON
- create
- decode
- decodeDelimited
- define
- encode
- encodeDelimited
- fromObject
- get
- getEnum
- getOption
- getTypeUrl
- isReservedId
- isReservedName
- lookup
- lookup
- lookupEnum
- lookupService
- lookupType
- lookupTypeOrEnum
- onAdd
- onRemove
- remove
- resolve
- resolveAll
- setOption
- setOptions
- setParsedOption
- setup
- toJSON
- toObject
- toString
- verify
- d
- fromJSON
- generateConstructor
Writer
- head
- len
- states
- tail
- bool
- bytes
- double
- finish
- finishInto
- fixed32
- fixed64
- float
- fork
- int32
- int64
- ldelim
- raw
- reset
- sfixed32
- sfixed64
- sint32
- sint64
- string
- uint32
- uint64
- alloc
- create
rpc.Service
- requestDelimited
- responseDelimited
- rpcImpl
- emit
- end
- off
- on
- rpcCall
util.EventEmitter
- emit
- off
- on
util.LongBits
- hi
- lo
- zero
- zeroHash
- length
- toHash
- toLong
- toNumber
- zzDecode
- zzEncode
- from
- fromHash
- fromNumber
util.ProtocolError
- instance
Interfaces
Buffer
IConversionOptions
IEnum
IExtensionField
IExtensionMapField
IFetchOptions
IField
IMapField
IMethod
INamespace
IOneOf
IParseOptions
IParserResult
IService
IToJSONOptions
ITokenizerHandle
IType
IWrapper
Long
common.IAny
common.IBoolValue
common.IBytesValue
common.IDoubleValue
common.IDuration
common.IEmpty
common.IFieldMask
common.IFloatValue
common.IInt32Value
common.IInt64Value
common.IListValue
common.IStringValue
common.IStruct
common.ITimestamp
common.IUInt32Value
common.IUInt64Value
common.IValue

Interface: IMapField

IMapField

mapfield.js, line 54

Map field descriptor.

Properties:

keyType

string

Key type

Extends

IField