actions/languageservices
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add some docs for findToken

Browse Source
This commit is contained in:
Christopher Schleiden
2022-11-22 16:53:01 -08:00
parent bca45e9eab
commit 3eabb5ad81
1 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
actions-languageservice/src/utils/find-token.ts
+12
View File
@@ -16,6 +16,18 @@ export type TokenResult = {
parent: TemplateToken | null; parent: TemplateToken | null;
}; };
/**
* Find a token at the given position in the document.
*
* If the position is within
* - the key of a mapping, parent will be the mapping, keyToken will be null, and token will be the key.
* - the value of a mapping, parent will be the mapping, keyToken will be the key for the value, and token will be the value
* - a sequence item, parent will be the sequence, keyToken will be null, and token will be the item
*
* @param pos Position within the document for which to find a token
* @param root Root node
* @returns Token result
*/
export function findToken(pos: Position, root?: TemplateToken): TokenResult { export function findToken(pos: Position, root?: TemplateToken): TokenResult {
if (!root) { if (!root) {
return { return {