Class QP

Represents a QP.

Hierarchy

  • QP

Implements

Constructors

constructor

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject toObject verify

Constructors

constructor

  • Constructs a new QP.

    Parameters

    • Optional properties: IQP

      Properties to set

    Returns QP

Methods

toJSON

  • Converts this QP to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • Creates a new QP instance using the specified properties.

    Parameters

    • Optional properties: IQP

      Properties to set

    Returns QP

    QP instance

Static decode

  • Decodes a QP message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns QP

    QP

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns QP

    QP

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static encode

  • Encodes the specified QP message. Does not implicitly verify messages.

    Parameters

    • message: IQP

      QP message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static encodeDelimited

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

    Parameters

    • message: IQP

      QP message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns QP

    QP

Static toObject

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

    Parameters

    • message: QP

      QP

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • Verifies a QP message.

    Parameters

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

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc