Class SubtractTask

This task will subtract a numerical input by a scalar value from a job of subtasks, an aggregator, or a big.

Input: The current running numerical result output from a scalar value, an aggregator, a job of subtasks or a big.

Returns: A numerical result.

Example: Returns the numerical result by subtracting by a job of subtasks.

{"tasks":[{"valueTask":{"value":100}},{"subtractTask":{"job":{"tasks":[{"valueTask":{"value":10}}]}}}]}

Example: Returns the numerical result by multiplying by an aggregator.

{"tasks":[{"valueTask":{"value":100}},{"subtractTask":{"aggregatorPubkey":"GvDMxPzN1sCj7L26YDK2HnMRXEQmQ2aemov8YBtPS7vR"}}]}

Example: Returns the numerical result by multiplying by a big.

{"tasks":[{"cacheTask":{"cacheItems":[{"variableName":"TEN","job":{"tasks":[{"valueTask":{"value":10}}]}}]}},{"valueTask":{"value":100}},{"subtractTask":{"big":"${TEN}"}}]}

Implements

Constructors

constructor

Properties

aggregatorPubkey? big? job? scalar? Subtraction?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new SubtractTask(properties?: ISubtractTask): SubtractTask

    Constructs a new SubtractTask.

    Parameters

    Returns SubtractTask

Properties

OptionalaggregatorPubkey

aggregatorPubkey?: string

Specifies an aggregator to subtract by.

Optionalbig

big?: string

A stringified big.js. Accepts variable expansion syntax.

Optionaljob

job?: IOracleJob

A job whose result is computed before subtracting our numerical input by that result.

Optionalscalar

scalar?: number

Specifies a scalar to subtract by.

OptionalSubtraction

Subtraction?: "aggregatorPubkey" | "big" | "scalar" | "job"

SubtractTask Subtraction.

Methods

toJSON

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

    Converts this SubtractTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: ISubtractTask): SubtractTask

    Creates a new SubtractTask instance using the specified properties.

    Parameters

    Returns SubtractTask

    SubtractTask instance

Staticdecode

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

    Decodes a SubtractTask 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 SubtractTask

    SubtractTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns SubtractTask

    SubtractTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: ISubtractTask

      SubtractTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: ISubtractTask

      SubtractTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns SubtractTask

    SubtractTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for SubtractTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    • message: SubtractTask

      SubtractTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a SubtractTask message.

    Parameters

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

      Plain object to verify

    Returns string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods