☁️ Loving our new documentation website? Provide feedback in the CloudCannon Community! ✨

Developer ReferenceConfiguration File

string_boundary

Table of contents

Description:

This key defines the valid tokens that can bound a string when parsing literal values.

The value is an array of strings, where each string specifies a valid boundary token. The parser will ensure the matched end token is the same as the start token. To handle common strings with either single or double quotes, this would usually be ["'", "\""].

Appears in:
└── Snippet
    └── params
        └── *
            └── Literal Parser Configuration
                └── options
                    └── format
                        └── string_boundary
Type:
Array<string_boundary[*]>
Items:
[*]string#

This key represents an individual string boundary token in the params.*(literal-parser-config).options.format.string_boundary array.

The value is a string that specifies a valid boundary token for strings. The parser will ensure the matched end token is the same as the start token.

Show examplesHide examples

In this example, we have configured a string boundary to use double quotes for literal parser.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[literal_param]]>>
    params:
      literal_param:
        parser: literal
        options:
          literal: specific-value
          format:
            string_boundary:
              - '"'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[literal_param]]>>",
      "params": {
        "literal_param": {
          "parser": "literal",
          "options": {
            "literal": "specific-value",
            "format": {
              "string_boundary": [
                "\""
              ]
            }
          }
        }
      }
    }
  }
}
Examples:

In this example, we have configured string boundaries to allow single and double quotes for literal parser.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[literal_param]]>>
    params:
      literal_param:
        parser: literal
        options:
          literal: specific-value
          format:
            string_boundary:
              - '"'
              - ''''
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[literal_param]]>>",
      "params": {
        "literal_param": {
          "parser": "literal",
          "options": {
            "literal": "specific-value",
            "format": {
              "string_boundary": [
                "\"",
                "'"
              ]
            }
          }
        }
      }
    }
  }
}
Open in a new tab