Skip to main content

prepareAuthoringRename

@gooi/language-server

@gooi/language-server / features/rename/prepare-authoring-rename / prepareAuthoringRename

Function: prepareAuthoringRename()

prepareAuthoringRename(value): { ok: true; parity: { issues: object[]; lockfileHash: string; status: "matched" | "mismatch"; }; placeholder: string; range: { end: { character: number; line: number; }; start: { character: number; line: number; }; }; symbolId: string; } | { error: { code: "authoring_symbol_error" | "rename_conflict_error"; message: string; }; ok: false; parity: { issues: object[]; lockfileHash: string; status: "matched" | "mismatch"; }; }

Defined in: authoring/language-server/src/features/rename/prepare-authoring-rename.ts:16

Preflights rename viability for textDocument/prepareRename handlers.

Parameters​

ParameterTypeDescription
valueunknownUntrusted prepare-rename request.

Returns​

{ ok: true; parity: { issues: object[]; lockfileHash: string; status: "matched" | "mismatch"; }; placeholder: string; range: { end: { character: number; line: number; }; start: { character: number; line: number; }; }; symbolId: string; } | { error: { code: "authoring_symbol_error" | "rename_conflict_error"; message: string; }; ok: false; parity: { issues: object[]; lockfileHash: string; status: "matched" | "mismatch"; }; }

Structured prepare-rename result.

Example​

const result = prepareAuthoringRename({ context, position: { line: 5, character: 12 } });