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?): CronParseTask

  • Constructs a new CronParseTask.

    Parameters

    Returns 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

    • [k: string]: any

Static create

  • create(properties?): CronParseTask

  • Creates a new CronParseTask instance using the specified properties.

    Parameters

    Returns CronParseTask

    CronParseTask instance

Static decode

  • decode(reader, length?): CronParseTask

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

    CronParseTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Static decodeDelimited

  • decodeDelimited(reader): CronParseTask

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

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns CronParseTask

    CronParseTask

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

    Parameters

    • message: ICronParseTask

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

    Parameters

    • message: ICronParseTask

      CronParseTask message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

Static fromObject

  • fromObject(object): CronParseTask

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

    Parameters

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

      Plain object

      • [k: string]: any

    Returns CronParseTask

    CronParseTask

Static getTypeUrl

  • getTypeUrl(typeUrlPrefix?): string

  • Gets the default type url for CronParseTask

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

    Parameters

    • message: CronParseTask

      CronParseTask

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any

Static verify

  • verify(message): string

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

constructorclockclockOffsetcronPatterntoJSONcreatedecodedecodeDelimitedencodeencodeDelimitedfromObjectgetTypeUrltoObjectverify