Class SymbolService

constructor

• new SymbolService(eventTarget: EventTargetOrCommChannel): SymbolService

  Create a service for the specific worker

  Parameters

  • eventTarget: EventTargetOrCommChannel

  Returns SymbolService

  Deprecated

  Prefer constructing the specific service (e.g. new VariableService(eventTarget)).

ReadonlyeventTarget

generateFunction

• generateFunction(
      suggestedName: string,
      moduleName?: string,
  ): Promise<URFunction>

  Generates a new function. The function name is based on the suggested name. If the suggested name is not usable a new, based on the suggestion, will be created

  Parameters

  • suggestedName: string
  • OptionalmoduleName: string

  Returns Promise<URFunction>

  Deprecated

  Use FunctionService.createFunction(name).

generateLogicProgram

• generateLogicProgram(suggestedName: string): Promise<URLogicProgram>
  Experimental

  Generates a new Logic Program. The program name is based on the suggested name. If the suggested name is not usable a new, based on the suggestion, will be created

  Parameters

  • suggestedName: string

  Returns Promise<URLogicProgram>

  Promise<URLogicProgram> A promise that resolves to the created logic program.

generateModule

• generateModule(suggestedName: string): Promise<URModule>

  Generates a new module. The module name is based on the suggested name. If the suggested name is not usable a new, based on the suggestion, will be created

  Parameters

  • suggestedName: string

  Returns Promise<URModule>

  Deprecated

  Use ModuleService.createModule(name).

generateVariable

• generateVariable(
      suggestedName: string,
      valueType: VariableValueType,
      blacklist?: string[],
  ): Promise<URVariable>

  Generates a new variable. The variable name is based on the suggested name. If the suggested name is not usable a new, based on the suggestion, will be created

  Parameters

  • suggestedName: string

    The intended name for the variable, will be suffixed if the name is already taken

  • valueType: VariableValueType

    The ValueType of the variable

  • Optionalblacklist: string[]

    Optional parameter to provide additional names which shouldn't be used.

  Returns Promise<URVariable>

  Deprecated

  Use VariableService.createVariable(name, variableType); perform your own naming conflict resolution if needed.

getFunctions

• getFunctions(moduleName?: string): Promise<URFunction[]>

  Get a list of available functions for the given module name. If no name provided, functions for the global scope

  Parameters

  • OptionalmoduleName: string

  Returns Promise<URFunction[]>

  Deprecated

  Use FunctionService.functions() then filter by module (description contains module reference).

getFunctionsMap

• getFunctionsMap(filter?: { filterAsync?: boolean }): Promise<FunctionsMap>

  Get functions map. Contains a list of functions for each module name. Note: Empty string is the global scope.

  Parameters

  • Optionalfilter: { filterAsync?: boolean }

    Filter on if the function is async or not is async or not

  Returns Promise<FunctionsMap>

  Deprecated

  Prefer querying FunctionService.functions() and building maps client-side; async filtering can be applied locally.

getLogicProgramNames

• getLogicProgramNames(): Promise<string[]>
  Experimental

  Return a list of available Logic Program names

  Returns Promise<string[]>

  Promise<Array> A promise that resolves to an array of logic program names.

getModuleNames

• getModuleNames(): Promise<string[]>

  Get a list of available modules

  Returns Promise<string[]>

  Deprecated

  Use ModuleService.modules() for reactive module listing.

getVariable

• getVariable(name: string): Promise<URVariable | undefined>

  Get the URVariable with the given name

  Parameters

  • name: string

    Name of the variable to get

  Returns Promise<URVariable | undefined>

  URVariable with the given name

  Deprecated

  Use VariableService.getVariableDescription(reference) once you have a reference; avoid name-based lookups.

getVariables

• getVariables(): Promise<URVariable[]>

  Get a list of available variables

  Returns Promise<URVariable[]>

  Deprecated

  Use VariableService.variables() to observe variable descriptions.

globalVariables

• globalVariables(): Observable<GlobalVariable[]>

  Returns a list of the global variables as a stream.

  Returns Observable<GlobalVariable[]>

  Observable of global variables object

  Deprecated

  Use VariableService.variables(); global variables are exposed uniformly via variable descriptions.

isAsyncFunction

• isAsyncFunction(functionName: string, moduleName?: string): Promise<boolean>

  Return true if the function is a thread

  Parameters

  • functionName: string

    The name of the function

  • OptionalmoduleName: string

    The module of the symbol if defined

  Returns Promise<boolean>

  Boolean describing if the function is a thread

  Deprecated

  Use metadata from FunctionService.functions() when async/thread capability is surfaced there.

isRegisteredFunctionName

• isRegisteredFunctionName(
      functionName: string,
      moduleName?: string,
  ): Promise<boolean>

  Return true if the provided name is the name of a registered function

  Parameters

  • functionName: string
  • OptionalmoduleName: string

  Returns Promise<boolean>

  Deprecated

  Use FunctionService.functions() and search for a matching name; no direct registration check helper.

isRegisteredLogicProgramName

• isRegisteredLogicProgramName(logicProgramName: string): Promise<boolean>
  Experimental

  Returns true if the provided name matches a registered Logic Program.

  Parameters

  • logicProgramName: string

    The name of the Logic Program to check for registration.

  Returns Promise<boolean>

  Promise A promise that resolves to true if the name is registered, otherwise false.

isRegisteredModuleName

• isRegisteredModuleName(moduleName: string): Promise<boolean>

  Return true if the provided name is the name of a registered module

  Parameters

  • moduleName: string

  Returns Promise<boolean>

  Deprecated

  Use ModuleService.modules() and search by name; no direct registration check helper.

isRegisteredName

• isRegisteredName(
      name: string,
      type: URSymbolType,
      moduleName?: string,
      unique?: boolean,
  ): Promise<boolean>

  Return true if the provided name is a registered name of the given type.

  Parameters

  • name: string
  • type: URSymbolType
  • OptionalmoduleName: string
  • Optionalunique: boolean

  Returns Promise<boolean>

  Deprecated

  Use the specific service (Variable/Function/Module) and inspect lists for existence; uniqueness checks should be done client-side.

isRegisteredVariableName

• isRegisteredVariableName(variableName: string): Promise<boolean>

  Return true if the provided name is the name of a registered variable

  Parameters

  • variableName: string

  Returns Promise<boolean>

  Deprecated

  Use VariableService.variables() and search by name; there's no direct registration check helper.

isSuppressed

• isSuppressed(name: string, moduleName?: string): Promise<boolean>

  Return true if the declaring program node is suppressed

  Parameters

  • name: string

    The name of the symbol

  • OptionalmoduleName: string

    The module of the symbol if defined

  Returns Promise<boolean>

  Boolean describing if the declaring node is suppressed

  Deprecated

  Suppression is exposed via metadata on objects with the VariableDescription, FunctionDescription and ModuleDescription type. Query entities on the corresponding service (VariableService, FunctionService, ModuleService) and check for the isSuppressed property.

isValidVariable

• isValidVariable(
      variableName: string,
      acceptedTypes?: string[],
  ): Promise<boolean>

  Parameters

  • variableName: string

    name of the variable being validated

  • OptionalacceptedTypes: string[]

    an optional array of valid type strings, e.g., float.

  Returns Promise<boolean>

  true if the variable is registered not suppressed, and is of a valid value type

  Deprecated

  Compose validation using VariableService.variables() & description metadata instead.

variables

• variables(): Observable<URVariable[]>

  Get an observable of available variables

  Returns Observable<URVariable[]>

  Deprecated

  Use VariableService.variables() which returns richer descriptions including references.