Options
All
  • Public
  • Public/Protected
  • All
Menu

Module ParseScript

Parses a script for validation and auto-completion.

Can be used as the user types their script, for that purpose use these parameters:

  • Type: Fast, doing Full performs a full compilation of the script which can take longer. Using Full can be done before the user hits the Save button, or for example every 10th keystroke or so.
  • IncludeAST: False, if you don't use the AST this will greatly reduce the response size.

Use IncludeCompletionSuggestions if you want to display auto-completion suggestions to the user.

You can verify the entire script and get completion results by passing in the full script as the Source and only the text until the user's cursor in the CompletionSource.

A list of the available dialects can be retrieved by calling GetScriptDialects.

Index

Interfaces

Properties

Properties

Optional AvailableVariablesRequest

AvailableVariablesRequest: AvailableVariablesRequestInfo

Optional CompletionSource

CompletionSource: undefined | string

The script that you want to have auto-completion suggestions for. This can be different than the full Source as you only want to provide completion suggestions at the current cursor position, so you can provide the full source for validation purposes and provide the script up to the cursor position for auto-completion suggestions.

Optional Dialect

Dialect: undefined | string

Optional DocumentationRequest

DocumentationRequest: DocumentationRequestInfo

Optional IncludeAST

IncludeAST: undefined | false | true

Optional IncludeCompletionSuggestions

IncludeCompletionSuggestions: undefined | false | true

Optional Source

Source: undefined | string

The script to parse.

Optional Type

Type: ParseTypes