Class Autocomplete

A helper class that can be used in syntax editors.

Index

Constructors

Methods

getSuggestionsAt normalizeSyntax tokenize getSuggestionsToComplete isMidToken isFunctionArgument getKindsToSuggest getSuggestionsByKind getSuggestionsByReturnType canComeAfter canComeBefore

Constructors

constructor

new Autocomplete(workspace: Workspace): Autocomplete
Create an autocomplete instance tailored to a given workspace.
Parameters
- workspace: Workspace
  the workspace to provide suggestions for.
Returns Autocomplete
- Defined in src/autocomplete/autocomplete.ts:61

Methods

getSuggestionsAt

getSuggestionsAt(cursor: number, text: string): AutocompleteSuggestion[]
Get suggestions suitable for a given cursor position in a given line.
Parameters
- cursor: number
  the position of the cursor relative to the start of the line.
- text: string
  the complete line where the cursor is positioned.
Returns AutocompleteSuggestion[]
an array of suggestions that can be displayed.
- Defined in src/autocomplete/autocomplete.ts:75

`Protected`normalizeSyntax

normalizeSyntax(syntax: string): string
Parameters
- syntax: string
Returns string
- Defined in src/autocomplete/autocomplete.ts:127

`Protected`tokenize

tokenize(syntax: string): string[]
Parameters
- syntax: string
Returns string[]
- Defined in src/autocomplete/autocomplete.ts:137

`Protected`getSuggestionsToComplete

getSuggestionsToComplete(prefix: string): AutocompleteSuggestion[]
Parameters
- prefix: string
Returns AutocompleteSuggestion[]
- Defined in src/autocomplete/autocomplete.ts:145

`Protected`isMidToken

isMidToken(token: string): boolean
Parameters
- token: string
Returns boolean
- Defined in src/autocomplete/autocomplete.ts:154

`Protected`isFunctionArgument

isFunctionArgument(prior_tokens: string[]): { type: ArgumentType | undefined }
Parameters
- prior_tokens: string[]
Returns { type: ArgumentType | undefined }
- Defined in src/autocomplete/autocomplete.ts:172

`Protected`getKindsToSuggest

getKindsToSuggest(cursor: number, text: string): AutocompleteKind[]
Parameters
- cursor: number
- text: string
Returns AutocompleteKind[]
- Defined in src/autocomplete/autocomplete.ts:234

`Protected`getSuggestionsByKind

getSuggestionsByKind(kind: AutocompleteKind): AutocompleteSuggestion[]
Parameters
- kind: AutocompleteKind
Returns AutocompleteSuggestion[]
- Defined in src/autocomplete/autocomplete.ts:250

`Protected`getSuggestionsByReturnType

getSuggestionsByReturnType(returnType: string): AutocompleteSuggestion[]
Parameters
- returnType: string
Returns AutocompleteSuggestion[]
- Defined in src/autocomplete/autocomplete.ts:255

`Protected`canComeAfter

canComeAfter(
suggestion: AutocompleteSuggestion,
preceding: AutocompleteSuggestion,
): boolean
Parameters
- suggestion: AutocompleteSuggestion
- preceding: AutocompleteSuggestion
Returns boolean
- Defined in src/autocomplete/autocomplete.ts:259

`Protected`canComeBefore

canComeBefore(
suggestion: AutocompleteSuggestion,
following: AutocompleteSuggestion,
): boolean
Parameters
- suggestion: AutocompleteSuggestion
- following: AutocompleteSuggestion
Returns boolean
- Defined in src/autocomplete/autocomplete.ts:293