Class Header

constructor

• new Header(properties?: IHeader): Header

  Constructs a new Header.

  Parameters

  • Optionalproperties: IHeader

    Properties to set

  Returns Header

key

value

toJSON

• toJSON(): { [k: string]: any }

  Converts this Header to JSON.

  Returns { [k: string]: any }

  JSON object

Staticcreate

• create(properties?: IHeader): Header

  Creates a new Header instance using the specified properties.

  Parameters

  • Optionalproperties: IHeader

    Properties to set

  Returns Header

  Header instance

Staticdecode

• decode(reader: Uint8Array<ArrayBufferLike> | Reader, length?: number): Header

  Decodes a Header message from the specified reader or buffer.

  Parameters

  • reader: Uint8Array<ArrayBufferLike> | Reader

    Reader or buffer to decode from
  • Optionallength: number

    Message length if known beforehand

  Returns Header

  Header

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

StaticdecodeDelimited

• decodeDelimited(reader: Uint8Array<ArrayBufferLike> | Reader): Header

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

  Parameters

  • reader: Uint8Array<ArrayBufferLike> | Reader

    Reader or buffer to decode from

  Returns Header

  Header

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Staticencode

• encode(message: IHeader, writer?: Writer): Writer

  Encodes the specified Header message. Does not implicitly verify messages.

  Parameters

  • message: IHeader

    Header message or plain object to encode
  • Optionalwriter: Writer

    Writer to encode to

  Returns Writer

  Writer

StaticencodeDelimited

• encodeDelimited(message: IHeader, writer?: Writer): Writer

  Encodes the specified Header message, length delimited. Does not implicitly verify messages.

  Parameters

  • message: IHeader

    Header message or plain object to encode
  • Optionalwriter: Writer

    Writer to encode to

  Returns Writer

  Writer

StaticfromObject

• fromObject(object: { [k: string]: any }): Header

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

  Parameters

  • object: { [k: string]: any }

    Plain object

  Returns Header

  Header

StaticgetTypeUrl

• getTypeUrl(typeUrlPrefix?: string): string

  Gets the default type url for Header

  Parameters

  • OptionaltypeUrlPrefix: string

    your custom typeUrlPrefix(default "type.googleapis.com")

  Returns string

  The default type url

StatictoObject

• toObject(message: Header, options?: IConversionOptions): { [k: string]: any }

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

  Parameters

  • message: Header

    Header
  • Optionaloptions: IConversionOptions

    Conversion options

  Returns { [k: string]: any }

  Plain object

Staticverify

• verify(message: { [k: string]: any }): string

  Verifies a Header message.

  Parameters

  • message: { [k: string]: any }

    Plain object to verify

  Returns string

  null if valid, otherwise the reason why it is not