getAuthoringHover
@gooi/language-server / features/navigation/get-authoring-hover / getAuthoringHover
Function: getAuthoringHover()
getAuthoringHover(
value):object
Defined in: authoring/language-server/src/features/navigation/get-authoring-hover.ts:18
Resolves hover payload for a cursor position in the active document.
Parameters
| Parameter | Type | Description |
|---|---|---|
value | unknown | Untrusted navigation request. |
Returns
object
Hover payload with parity state.
hover
hover: {
contents:string;range: {end: {character:number;line:number; };start: {character:number;line:number; }; };symbolId:string; } |null
parity
parity:
object=authoringParityStateSchema
Type Declaration
parity.issues
issues:
object[]
Type Declaration
parity.lockfileHash
lockfileHash:
string=hashSchema
parity.status
status:
"matched"|"mismatch"
Example
const result = getAuthoringHover({ context, position: { line: 3, character: 12 } });