Class CronParseTask

Return a timestamp from a crontab instruction.

Input: None

Returns: A timestamp

Example: Return the unix timestamp for the on-chain SYSCLOCK

{"cronParseTask":{"cronPattern":"* * * * * *","clockOffset":0,"clock":"SYSCLOCK"}}

Example: Return the unix timestamp for next friday at 5pm UTC

{"cronParseTask":{"cronPattern":"0 17 * * 5","clockOffset":0,"clock":0}}

Implements

Constructors

constructor

Properties

clock clockOffset cronPattern

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new CronParseTask(properties?: ICronParseTask): OracleJob.CronParseTask

    Constructs a new CronParseTask.

    Parameters

    Returns OracleJob.CronParseTask

Properties

clock

clock: ClockType

Use the TaskRunner's clock or the on-chain SYSCLOCK.

clockOffset

clockOffset: number

The timestamp offset to calculate the next run.

cronPattern

cronPattern: string

The cron pattern to parse.

Methods

toJSON

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

    Converts this CronParseTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: ICronParseTask): OracleJob.CronParseTask

    Creates a new CronParseTask instance using the specified properties.

    Parameters

    Returns OracleJob.CronParseTask

    CronParseTask instance

Staticdecode

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

    Decodes a CronParseTask 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 OracleJob.CronParseTask

    CronParseTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

  • decodeDelimited(
        reader: Uint8Array<ArrayBufferLike> | Reader,
    ): OracleJob.CronParseTask

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns OracleJob.CronParseTask

    CronParseTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: ICronParseTask

      CronParseTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: ICronParseTask

      CronParseTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

  • fromObject(object: { [k: string]: any }): OracleJob.CronParseTask

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

    Parameters

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

      Plain object

    Returns OracleJob.CronParseTask

    CronParseTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for CronParseTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    Returns { [k: string]: any }

    Plain object

Staticverify

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

    Verifies a CronParseTask 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