Class ValueTask

Returns a specified value.

Input: None

Returns: A numerical result.

Example: Returns the value 10

{"valueTask": {"value": 10} }

Example: Returns the currentRound result of an aggregator

{"valueTask": {"aggregatorPubkey": "GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR"} }

Example: Returns the value stored in a CacheTask variable

{"valueTask": {"big": "${ONE}"} }

Implements

Constructors

constructor

Properties

Value? aggregatorPubkey? big? hex? utf8? value?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new ValueTask(properties?): ValueTask

  • Constructs a new ValueTask.

    Parameters

    Returns ValueTask

Properties

Optional Value

Value?: "big" | "utf8" | "hex" | "value" | "aggregatorPubkey"

ValueTask Value.

Optional aggregatorPubkey

aggregatorPubkey?: string

Specifies an aggregatorr to pull the value of.

Optional big

big?: string

A stringified big.js. Accepts variable expansion syntax.

Optional hex

hex?: string

A stringified hex number (0x prefix is optional).

Optional utf8

utf8?: string

A utf8 string.

Optional value

value?: number

The value that will be returned from this task.

Methods

toJSON

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

  • Converts this ValueTask to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • create(properties?): ValueTask

  • Creates a new ValueTask instance using the specified properties.

    Parameters

    Returns ValueTask

    ValueTask instance

Static decode

  • decode(reader, length?): ValueTask

  • Decodes a ValueTask 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 ValueTask

    ValueTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): ValueTask

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns ValueTask

    ValueTask

    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 ValueTask message. Does not implicitly verify messages.

    Parameters

    • message: IValueTask

      ValueTask 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 ValueTask message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IValueTask

      ValueTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): ValueTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns ValueTask

    ValueTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for ValueTask

    Parameters

    • Optional typeUrlPrefix: string

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

    Returns string

    The default type url

Static toObject

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

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

    Parameters

    • message: ValueTask

      ValueTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

  • Verifies a ValueTask message.

    Parameters

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

      Plain object to verify

      • [k: string]: any

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

Theme

On This Page

constructorValueaggregatorPubkeybighexutf8valuetoJSONcreatedecodedecodeDelimitedencodeencodeDelimitedfromObjectgetTypeUrltoObjectverify