github.com/Jeffail/benthos/v3@v3.65.0/website/docs/components/processors/text.md (about)

     1  ---
     2  title: text
     3  type: processor
     4  status: deprecated
     5  ---
     6  
     7  <!--
     8       THIS FILE IS AUTOGENERATED!
     9  
    10       To make changes please edit the contents of:
    11       lib/processor/text.go
    12  -->
    13  
    14  import Tabs from '@theme/Tabs';
    15  import TabItem from '@theme/TabItem';
    16  
    17  :::warning DEPRECATED
    18  This component is deprecated and will be removed in the next major version release. Please consider moving onto [alternative components](#alternatives).
    19  :::
    20  
    21  
    22  <Tabs defaultValue="common" values={[
    23    { label: 'Common', value: 'common', },
    24    { label: 'Advanced', value: 'advanced', },
    25  ]}>
    26  
    27  <TabItem value="common">
    28  
    29  ```yaml
    30  # Common config fields, showing default values
    31  label: ""
    32  text:
    33    operator: trim_space
    34    arg: ""
    35    value: ""
    36  ```
    37  
    38  </TabItem>
    39  <TabItem value="advanced">
    40  
    41  ```yaml
    42  # All config fields, showing default values
    43  label: ""
    44  text:
    45    operator: trim_space
    46    arg: ""
    47    value: ""
    48    parts: []
    49  ```
    50  
    51  </TabItem>
    52  </Tabs>
    53  
    54  ## Fields
    55  
    56  ### `operator`
    57  
    58  A text based [operation](#operators) to execute.
    59  
    60  
    61  Type: `string`  
    62  Default: `"trim_space"`  
    63  Options: `append`, `escape_url_query`, `unescape_url_query`, `find_regexp`, `prepend`, `quote`, `regexp_expand`, `replace`, `replace_regexp`, `set`, `strip_html`, `to_lower`, `to_upper`, `trim`, `trim_space`, `unquote`.
    64  
    65  ### `arg`
    66  
    67  An argument for the operator (not always applicable).
    68  
    69  
    70  Type: `string`  
    71  Default: `""`  
    72  
    73  ### `value`
    74  
    75  A value to use with the operator.
    76  This field supports [interpolation functions](/docs/configuration/interpolation#bloblang-queries).
    77  
    78  
    79  Type: `string`  
    80  Default: `""`  
    81  
    82  ### `parts`
    83  
    84  An optional array of message indexes of a batch that the processor should apply to.
    85  If left empty all messages are processed. This field is only applicable when
    86  batching messages [at the input level](/docs/configuration/batching).
    87  
    88  Indexes can be negative, and if so the part will be selected from the end
    89  counting backwards starting from -1.
    90  
    91  
    92  Type: `array`  
    93  Default: `[]`  
    94  
    95  ## Alternatives
    96  
    97  All functionality of this processor has been superseded by the
    98  [bloblang](/docs/components/processors/bloblang) processor.
    99