Class RegexExtractTask

Find and extract text using regular expressions from the previous task's output.

Input: String output from previous task

Returns: The matched string based on the regex pattern and group number

Example: Extract the first number from a string

{
"regexExtractTask": {
"pattern": "\\d+",
"groupNumber": 0
}
}

Example: Extract text between quotes

{
"regexExtractTask": {
"pattern": "\"([^\"]+)\"",
"groupNumber": 1
}
}

Example: Extract the first JSON object from a stream

{
"regexExtractTask": {
"pattern": "\\{[^}]+\\}"
}
}

Implements

Constructors

constructor

Properties

groupNumber pattern

Methods

toJSON create decode decodeDelimited encode encodeDelimited fromObject getTypeUrl toObject verify

Constructors

constructor

  • new RegexExtractTask(properties?: IRegexExtractTask): RegexExtractTask

    Constructs a new RegexExtractTask.

    Parameters

    Returns RegexExtractTask

Properties

groupNumber

groupNumber: number

The capture group number to extract (0 returns full match, 1+ returns respective capture group). Defaults to 0 if not specified.

pattern

pattern: string

The regular expression pattern to match against the input string. Uses the fancy-regex Rust crate syntax.

Methods

toJSON

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

    Converts this RegexExtractTask to JSON.

    Returns { [k: string]: any }

    JSON object

Staticcreate

  • create(properties?: IRegexExtractTask): RegexExtractTask

    Creates a new RegexExtractTask instance using the specified properties.

    Parameters

    Returns RegexExtractTask

    RegexExtractTask instance

Staticdecode

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

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

    RegexExtractTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

StaticdecodeDelimited

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

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

    Parameters

    • reader: Uint8Array<ArrayBufferLike> | Reader

      Reader or buffer to decode from

    Returns RegexExtractTask

    RegexExtractTask

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

Staticencode

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

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

    Parameters

    • message: IRegexExtractTask

      RegexExtractTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticencodeDelimited

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

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

    Parameters

    • message: IRegexExtractTask

      RegexExtractTask message or plain object to encode

    • Optionalwriter: Writer

      Writer to encode to

    Returns Writer

    Writer

StaticfromObject

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

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

    Parameters

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

      Plain object

    Returns RegexExtractTask

    RegexExtractTask

StaticgetTypeUrl

  • getTypeUrl(typeUrlPrefix?: string): string

    Gets the default type url for RegexExtractTask

    Parameters

    Returns string

    The default type url

StatictoObject

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

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

    Parameters

    • message: RegexExtractTask

      RegexExtractTask

    • Optionaloptions: IConversionOptions

      Conversion options

    Returns { [k: string]: any }

    Plain object

Staticverify

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

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