InputMessage | protoflex

Represents a single message that was created by Protoflex and can be serialized to wire.

Hierarchy

InputMessage

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new InputMessage(): InputMessage

- Defined in index.d.ts:94
Returns InputMessage

Properties

Private Optional _parent

_parent: InputMessage

Holds a reference to parent message for chaining API

see: InputMessage.parent

fields

fields: Dict<MessageField[]>

Contains all fields ever added to the message.

Methods

append

append(key: number, value: number, type: PB_Number | PB_Fraction): InputMessage
append(key: number, value: Long, type: PB_Long): InputMessage
append(key: number, value: boolean, type: PB_Bool): InputMessage
append(key: number, value: number[], type: PB_Bytes): InputMessage
append(key: number, value: string, type: PB_String): InputMessage
append(key: number, value: InputMessage, type: PB_Message): InputMessage
append(key: number, value: any, type: any): InputMessage
append(key: number, value: any): InputMessage

- Defined in index.d.ts:373
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: number
  
  Newly added value
- type: PB_Number | PB_Fraction
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:383
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: Long
  
  Newly added value
- type: PB_Long
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:393
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: boolean
  
  Newly added value
- type: PB_Bool
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:403
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: number[]
  
  Newly added value
- type: PB_Bytes
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:413
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: string
  
  Newly added value
- type: PB_String
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:423
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: InputMessage
  
  Newly added value
- type: PB_Message
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:433
Add an item to the end of array at given key with type check

Parameters
- key: number
  
  Array key
- value: any
  
  Newly added value
- type: any
  
  Newly added item type
Returns InputMessage

this
- Defined in index.d.ts:442
Add an item to the end of array at given key without type check

Parameters
- key: number
  
  Array key
- value: any
  
  Newly added value
Returns InputMessage

this

array

array(key: number, type: PB_Fraction): number[]
array(key: number, type: PB_Number): Long[]
array(key: number, type: PB_Bool): boolean[]
array(key: number, type: PB_Bytes): number[][]
array(key: number, type: PB_String): string[]
array(key: number, type: PB_Message): InputMessage[]
array(key: number, type?: any): any[]

- Defined in index.d.ts:187
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- type: PB_Fraction
  
  Expected type of items in array
Returns number[]
- Defined in index.d.ts:195
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- type: PB_Number
  
  Expected type of items in array
Returns Long[]
- Defined in index.d.ts:203
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- type: PB_Bool
  
  Expected type of items in array
Returns boolean[]
- Defined in index.d.ts:211
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- type: PB_Bytes
  
  Expected type of items in array
Returns number[][]
- Defined in index.d.ts:219
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- type: PB_String
  
  Expected type of items in array
Returns string[]
- Defined in index.d.ts:227
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- type: PB_Message
  
  Expected type of items in array
Returns InputMessage[]
- Defined in index.d.ts:235
Get an array of fields with given key

Parameters
- key: number
  
  Key of items to be added into result
- Optional type: any
  
  Expected type of items in array (if not passed type checking is skipped)
Returns any[]

bool

bool(key: number, value: any, index?: number): InputMessage

- Defined in index.d.ts:496
Adds a bool field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: any
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

bytes

bytes(key: number, value: BufferLike, index?: number): InputMessage

- Defined in index.d.ts:486
Adds a bytes field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: BufferLike
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

clear

clear(): InputMessage
clear(key: number): InputMessage
clear(key: number, index: number): InputMessage

- Defined in index.d.ts:449
Clears whole message removing all fields ever added to it

Returns InputMessage

this
- Defined in index.d.ts:457
Removes message's fields with given key

Parameters
- key: number
  
  Message key to be cleared
Returns InputMessage

this
- Defined in index.d.ts:466
Removes message's field with given key and index

Parameters
- key: number
  
  Message key
- index: number
  
  Key index to be removed
Returns InputMessage

this

double

double(key: number, value: number, index?: number): InputMessage

- Defined in index.d.ts:576
Adds a double field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

editMessage

editMessage(key: number, index?: number): InputMessage
editMessage(key: number, callback: function, index?: number): void

- Defined in index.d.ts:650
Edit am existing sub-message field in the resulting message with key key and optional index. Returns that message, parent can be referenced using .parent().

Use this instead of get when using OutputMessage.toInput

see

InputMessage.parent

Parameters
- key: number
  
  Key of the message field
- Optional index: number
  
  Index of newly message field
Returns InputMessage

message to be edited
- Defined in index.d.ts:662
Edit am existing sub-message field in the resulting message with key key and optional index. Returns that message, parent can be referenced using .parent().

Use this instead of get when using OutputMessage.toInput

Parameters
- key: number
  
  Key of the message field
- callback: function
  
  Callback function for the message
  - - (msg: InputMessage): void
    - Parameters
      - msg: InputMessage
      Returns void
- Optional index: number
  
  Index of newly message field
Returns void

end

end(): InputMessage

- Defined in index.d.ts:677
Similarly to InputMessage.parent, returns parent message Throws error when message is root.

Returns InputMessage

parent message

fixed32

fixed32(key: number, value: number, index?: number): InputMessage

- Defined in index.d.ts:586
Adds a fixed32 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

fixed64

fixed64(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:606
Adds a fixed64 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

float

float(key: number, value: number, index?: number): InputMessage

- Defined in index.d.ts:566
Adds a float field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

get

get(key: number, index?: number): any
get(key: number, type: PB_Fraction, index?: number): number
get(key: number, type: PB_Number, index?: number): Long
get(key: number, type: PB_Bool, index?: number): boolean
get(key: number, type: PB_Bytes, index?: number): number[]
get(key: number, type: PB_String, index?: number): string
get(key: number, type: PB_Message, index?: number): InputMessage
get(key: number, type?: any, index?: number): any

- Defined in index.d.ts:115
Get a field value by key and optionally index

Parameters
- key: number
  
  Field key
- Optional index: number
  
  Field value
Returns any
- Defined in index.d.ts:124
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- type: PB_Fraction
  
  Field type
- Optional index: number
  
  Field value
Returns number
- Defined in index.d.ts:133
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- type: PB_Number
  
  Field type
- Optional index: number
  
  Field value
Returns Long
- Defined in index.d.ts:142
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- type: PB_Bool
  
  Field type
- Optional index: number
  
  Field value
Returns boolean
- Defined in index.d.ts:151
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- type: PB_Bytes
  
  Field type
- Optional index: number
  
  Field value
Returns number[]
- Defined in index.d.ts:160
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- type: PB_String
  
  Field type
- Optional index: number
  
  Field value
Returns string
- Defined in index.d.ts:169
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- type: PB_Message
  
  Field type
- Optional index: number
  
  Field value
Returns InputMessage
- Defined in index.d.ts:178
Get a field value by key, type and optionally index

Parameters
- key: number
  
  Field key
- Optional type: any
  
  Field type
- Optional index: number
  
  Field value
Returns any

int32

int32(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:506
Adds a int32 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

int64

int64(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:516
Adds a int64 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

iter

iter(key: number, editable: false, type: PB_Fraction): Iterator<number>
iter(key: number, editable: false, type: PB_Number): Iterator<Long>
iter(key: number, editable: false, type: PB_Bool): Iterator<boolean>
iter(key: number, editable: false, type: PB_Bytes): Iterator<number[]>
iter(key: number, editable: false, type: PB_String): Iterator<string>
iter(key: number, editable: false, type: PB_Message): Iterator<InputMessage>
iter(key: number, editable?: false, type?: any): Iterator<any>
iter(key: number, editable: true, type: PB_Fraction): Iterator<IterableReference<number>>
iter(key: number, editable: true, type: PB_Number): Iterator<IterableReference<Long>>
iter(key: number, editable: true, type: PB_Bool): Iterator<IterableReference<boolean>>
iter(key: number, editable: true, type: PB_Bytes): Iterator<IterableReference<number[]>>
iter(key: number, editable: true, type: PB_String): Iterator<IterableReference<string>>
iter(key: number, editable: true, type: PB_Message): Iterator<IterableReference<InputMessage>>
iter(key: number, editable: true, type?: any): Iterator<IterableReference<any>>

- Defined in index.d.ts:245
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: false
  
  Whether to return items by reference
- type: PB_Fraction
  
  Expected type of iterables
Returns Iterator<number>
- Defined in index.d.ts:254
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: false
  
  Whether to return items by reference
- type: PB_Number
  
  Expected type of iterables
Returns Iterator<Long>
- Defined in index.d.ts:263
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: false
  
  Whether to return items by reference
- type: PB_Bool
  
  Expected type of iterables
Returns Iterator<boolean>
- Defined in index.d.ts:272
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: false
  
  Whether to return items by reference
- type: PB_Bytes
  
  Expected type of iterables
Returns Iterator<number[]>
- Defined in index.d.ts:281
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: false
  
  Whether to return items by reference
- type: PB_String
  
  Expected type of iterables
Returns Iterator<string>
- Defined in index.d.ts:290
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: false
  
  Whether to return items by reference
- type: PB_Message
  
  Expected type of iterables
Returns Iterator<InputMessage>
- Defined in index.d.ts:299
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- Optional editable: false
  
  Whether to return items by reference
- Optional type: any
  
  Expected type of iterables (if not passed type checking is skipped)
Returns Iterator<any>
- Defined in index.d.ts:308
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- type: PB_Fraction
  
  Expected type of iterables
Returns Iterator<IterableReference<number>>
- Defined in index.d.ts:317
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- type: PB_Number
  
  Expected type of iterables
Returns Iterator<IterableReference<Long>>
- Defined in index.d.ts:326
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- type: PB_Bool
  
  Expected type of iterables
Returns Iterator<IterableReference<boolean>>
- Defined in index.d.ts:335
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- type: PB_Bytes
  
  Expected type of iterables
Returns Iterator<IterableReference<number[]>>
- Defined in index.d.ts:344
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- type: PB_String
  
  Expected type of iterables
Returns Iterator<IterableReference<string>>
- Defined in index.d.ts:353
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- type: PB_Message
  
  Expected type of iterables
Returns Iterator<IterableReference<InputMessage>>
- Defined in index.d.ts:362
Get an iterator of fields with given key

Parameters
- key: number
  
  Key of items to be iterated over
- editable: true
  
  Whether to return items by reference
- Optional type: any
  
  Expected type of iterables (if not passed type checking is skipped)
Returns Iterator<IterableReference<any>>

keepDefault

keepDefault(value?: boolean): this

- Defined in index.d.ts:735
Whether to keep default values in the wire (0 for ints, empty for messages/bytes/strings).

Defaults to false, to minimize resulting length.

Parameters
- Optional value: boolean
Returns this

message

message(key: number, index?: number): InputMessage
message(key: number, callback: function, index?: number): void

- Defined in index.d.ts:627
Adds a sub-message field to resulting message with key key and optional index. Returns newly created message, parent can be referenced using .parent()

see

InputMessage.parent

Parameters
- key: number
  
  Key of newly added message
- Optional index: number
  
  Index of newly added message
Returns InputMessage

newly created message
- Defined in index.d.ts:637
Adds a sub-message field to resulting message with key key and optional index. Calls callback with the message to allow you to populate it

Parameters
- key: number
  
  Key of newly added message
- callback: function
  
  Callback function for the new message
  - - (msg: InputMessage): void
    - Parameters
      - msg: InputMessage
      Returns void
- Optional index: number
  
  Index of newly added message
Returns void

parent

parent(): InputMessage | null

- Defined in index.d.ts:669
Get message's parent.

Returns InputMessage | null

parent message or null if current message is root.

serialize

serialize(): number[]

- Defined in index.d.ts:698
Serialize InputMessage to array of bytes, alias to InputMessage.toWire

Returns number[]

sfixed32

sfixed32(key: number, value: number, index?: number): InputMessage

- Defined in index.d.ts:596
Adds a sfixed32 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

sfixed64

sfixed64(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:616
Adds a sfixed64 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

sint32

sint32(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:546
Adds a sint32 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

sint64

sint64(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:556
Adds a sint64 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

string

string(key: number, value: any, index?: number): InputMessage

- Defined in index.d.ts:476
Adds a string field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: any
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

toArrayBuffer

toArrayBuffer(): Uint8Array

- Defined in index.d.ts:715
Serialize InputMessage to ArrayBuffer

Returns Uint8Array

toBuffer

toBuffer(): Buffer

- Defined in index.d.ts:703
Serialize InputMessage to Buffer

Returns Buffer

toHex

toHex(): string

- Defined in index.d.ts:720
Serialize InputMessage to hexadecimal string

Returns string

toJSON

toJSON(): any

- Defined in index.d.ts:725
Converts InputMessage to JSON API compatible representation.

Returns any

toUint8Array

toUint8Array(): Uint8Array

- Defined in index.d.ts:709
Serialize InputMessage to Uint8Array

Returns Uint8Array

toWire

toWire(): number[]

- Defined in index.d.ts:693
Serialize InputMessage to array of bytes

Returns number[]

uint32

uint32(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:526
Adds a uint32 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

uint64

uint64(key: number, value: number | string | Long, index?: number): InputMessage

- Defined in index.d.ts:536
Adds a uint64 field to resulting message with key key and optional index

Parameters
- key: number
  
  Key of newly added field
- value: number | string | Long
  
  Value of newly added field
- Optional index: number
  
  Index in array of newly added field.
Returns InputMessage

this

unpacked

unpacked(...fields: (number | number[])[]): InputMessage

- Defined in index.d.ts:688
By default, all packable fields (varints and fixed32/64) in resulting stream will be packed as seen here. To provide backwards-compatibility with proto2, some fields can be explicitly declared unpacked.

Parameters
- Rest ...fields: (number | number[])[]
  
  Field keys. Varargs accepting either numbers or a number array.
Returns InputMessage

this

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns InputMessage

Properties

Private Optional _parent

fields

Methods

append

Parameters

key: number

value: number

type: PB_Number | PB_Fraction

Returns InputMessage

Parameters

key: number

value: Long

type: PB_Long

Returns InputMessage

Parameters

key: number

value: boolean

type: PB_Bool

Returns InputMessage

Parameters

key: number

value: number[]

type: PB_Bytes

Returns InputMessage

Parameters

key: number

value: string

type: PB_String

Returns InputMessage

Parameters

key: number

value: InputMessage

type: PB_Message

Returns InputMessage

Parameters

key: number

value: any

type: any

Returns InputMessage

Parameters

key: number

value: any

Returns InputMessage

array

Parameters

key: number

type: PB_Fraction

Returns number[]

Parameters

key: number

type: PB_Number

Returns Long[]

Parameters

key: number

type: PB_Bool

Returns boolean[]

Parameters

key: number

type: PB_Bytes

Returns number[][]

Parameters

key: number

type: PB_String

Returns string[]

Parameters

key: number

type: PB_Message

Returns InputMessage[]

Parameters

key: number

Optional type: any