Class Option

constructor

• new Option(properties?): Option

• Constructs a new Option.

  Parameters

  • Optional properties: IOption

    Properties to set

  Returns Option

optionName

toJSON

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

• Converts this Option to JSON.

  Returns {
      [k: string]: any;
  }

  JSON object

  • [k: string]: any

Static create

• create(properties?): Option

• Creates a new Option instance using the specified properties.

  Parameters

  • Optional properties: IOption

    Properties to set

  Returns Option

  Option instance

Static decode

• decode(reader, length?): Option

• Decodes an Option 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 Option

  Option

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static decodeDelimited

• decodeDelimited(reader): Option

• Decodes an Option message from the specified reader or buffer, length delimited.

  Parameters

  • reader: Uint8Array | Reader

    Reader or buffer to decode from

  Returns Option

  Option

  Throws

  If the payload is not a reader or valid buffer

  Throws

  If required fields are missing

Static encode

• encode(message, writer?): Writer

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

  Parameters

  • message: IOption

    Option message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static encodeDelimited

• encodeDelimited(message, writer?): Writer

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

  Parameters

  • message: IOption

    Option message or plain object to encode

  • Optional writer: Writer

    Writer to encode to

  Returns Writer

  Writer

Static fromObject

• fromObject(object): Option

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

  Parameters

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

    Plain object

    • [k: string]: any

  Returns Option

  Option

Static toObject

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

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

  Parameters

  • message: Option

    Option

  • Optional options: IConversionOptions

    Conversion options

  Returns {
      [k: string]: any;
  }

  Plain object

  • [k: string]: any

Static verify

• verify(message): null | string

• Verifies an Option 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