Class DivideTask

This task will divide 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 dividing by a job of subtasks.

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

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

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

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

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

Implements

Constructors

constructor

Properties

aggregatorPubkey? big? Denominator? job? scalar?

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

Properties

OptionalaggregatorPubkey

aggregatorPubkey?: null | string

Specifies another aggregator resut to divide by.

Optionalbig

big?: null | string

A stringified big.js. Accepts variable expansion syntax.

OptionalDenominator

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

DivideTask Denominator.

Optionaljob

job?: null | IOracleJob

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

Optionalscalar

scalar?: null | number

Specifies a basic scalar denominator to divide by.

Methods

toJSON

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

    Converts this DivideTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IDivideTask): DivideTask

    Creates a new DivideTask instance using the specified properties.

    Parameters

    Returns DivideTask

    DivideTask instance

Staticdecode

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

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

    DivideTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns DivideTask

    DivideTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

    Encodes the specified DivideTask message. Does not implicitly {@apilink oracle_job.OracleJob.DivideTask.verify|verify} messages.

    Parameters

    • message: IDivideTask

      DivideTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

    Encodes the specified DivideTask message, length delimited. Does not implicitly {@apilink oracle_job.OracleJob.DivideTask.verify|verify} messages.

    Parameters

    • message: IDivideTask

      DivideTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns DivideTask

    DivideTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for DivideTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    • message: DivideTask

      DivideTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a DivideTask message.

    Parameters

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

      Plain object to verify

    Returns null | string

    null if valid, otherwise the reason why it is not

Settings

Member Visibility

On This Page

Constructors
Properties
Methods