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

Developer ReferenceConfiguration File

object_boundary

Table of contents

Description:

This key defines the characters that start and end object literals when parsing snippet parameters.

The value is an object that contains start and end properties, each specifying a string token. For objects, this will usually be { start: "{", end: "}" }.

Appears in:
└── Snippet Format
    └── object_boundary
Type:
Object
Properties:
endstring#

This key defines the end token for object boundaries when parsing snippet parameters.

The value is a string that specifies the token that marks the end of an object in snippet parameter parsing. This works together with object_boundary.start to define paired tokens that enclose objects.

Defaults to:

Show examplesHide examples

In this example, we have configured object boundaries to use curly braces.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[param]]>>
    params:
      param:
        parser: argument
        options:
          format:
            object_boundary:
              start: '{'
              end: '}'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[param]]>>",
      "params": {
        "param": {
          "parser": "argument",
          "options": {
            "format": {
              "object_boundary": {
                "start": "{",
                "end": "}"
              }
            }
          }
        }
      }
    }
  }
}
startstring#

This key defines the start token for object boundaries when parsing snippet parameters.

The value is a string that specifies the token that marks the start of an object in snippet parameter parsing. This works together with object_boundary.end to define paired tokens that enclose objects.

Defaults to:

Show examplesHide examples

In this example, we have configured object boundaries to use curly braces.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[param]]>>
    params:
      param:
        parser: argument
        options:
          format:
            object_boundary:
              start: '{'
              end: '}'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[param]]>>",
      "params": {
        "param": {
          "parser": "argument",
          "options": {
            "format": {
              "object_boundary": {
                "start": "{",
                "end": "}"
              }
            }
          }
        }
      }
    }
  }
}
Examples:

In this example, we have configured object boundaries to use curly braces.

Copied to clipboard
_snippets:
  example:
    snippet: <<example [[param]]>>
    params:
      param:
        parser: argument
        options:
          format:
            object_boundary:
              start: '{'
              end: '}'
{
  "_snippets": {
    "example": {
      "snippet": "<<example [[param]]>>",
      "params": {
        "param": {
          "parser": "argument",
          "options": {
            "format": {
              "object_boundary": {
                "start": "{",
                "end": "}"
              }
            }
          }
        }
      }
    }
  }
}
Open in a new tab