Skip to content

trim - Clean whitespace from a string

The trim function removes whitespace from the start and end of a given string value.

Syntax

trim(value: string): string

Arguments

NameTypeRequiredDescription
valuestringtrueThe string from which to remove whitespace

Example - Cleaning up an extracted username

Consider the following document:

{
  "message": "user  Chris  has logged in"
}

We want to extract the username from this string, so that we can search and query it directly. This can be done using the extract keyword with a regular expression.

extract message into my_data using regexp(e=/user (?<user>.*) has logged in/)

This results in this log object:

{
  "message": "user  Chris  has logged in",
  "my_data": {
    "user": " Chris "
  }
}

Notice the space at the start and end of the username. This is because a stray space has made its way in. We can use trim to clean this up:

replace my_data.user with my_data.user.trim()

This will remove the spaces from the username and result in a cleaner value.