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

Subtraction? aggregatorPubkey? big? job? scalar?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new SubtractTask(properties?): SubtractTask

  • Constructs a new SubtractTask.

    Parameters

    Returns SubtractTask

Properties

Optional Subtraction

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

SubtractTask Subtraction.

Optional aggregatorPubkey

aggregatorPubkey?: string

Specifies an aggregator to subtract by.

Optional big

big?: string

A stringified big.js. Accepts variable expansion syntax.

Optional job

job?: IOracleJob

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

Optional scalar

scalar?: number

Specifies a scalar to subtract by.

Methods

toJSON

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

  • Converts this SubtractTask to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any

Static create

  • create(properties?): SubtractTask

  • Creates a new SubtractTask instance using the specified properties.

    Parameters

    Returns SubtractTask

    SubtractTask instance

Static decode

  • decode(reader, length?): SubtractTask

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

    SubtractTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): SubtractTask

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

    Parameters

    • reader: Uint8Array | 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

Static encode

  • encode(message, writer?): Writer

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

    Parameters

    • message: ISubtractTask

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

    Parameters

    • message: ISubtractTask

      SubtractTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): SubtractTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns SubtractTask

    SubtractTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for SubtractTask

    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 SubtractTask message. Also converts values to other types if specified.

    Parameters

    • message: SubtractTask

      SubtractTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

  • Verifies a SubtractTask 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

Generated using TypeDoc