@jupyter-lsp/jupyterlab-lsp/lib/_completion.d.ts

Language Server Protocol integration for JupyterLab

/**
 * This file was automatically generated by json-schema-to-typescript.
 * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
 * and run json-schema-to-typescript to regenerate this file.
 */
/**
 * Whether to enable continuous hinting (Hinterland mode). Requires enabling autocompletion in the other 'Code completion' settings
 */
export type ContinuousHinting = boolean;
/**
 * An array of CodeMirror tokens for which the continuous hinting should be suppressed. The token names vary between languages (modes).
 */
export type SuppressInvokeContinuousHintingInSpecificCodeFragments = string[];
/**
 * An array of CodeMirror tokens for which the auto-invoke after entering a trigger (e.g. `.` in Python or `::` in R) character should be suppressed. The token names vary between languages (modes).
 */
export type SuppressInvokeViaTriggerCharacterInSpecificCodeFragments = string[];
/**
 * Should an attempt to get the kernel response (with timeout as specified by kernelResponseTimeout) be made if kernel is busy? If you often write code in notebook while computations are running for long time (e.g. training models), turning this off might give you faster response times.
 */
export type WaitForKernelIfBusy = boolean;
/**
 * The identifier of a completer theme with icons which indicate the kind of completion. Set to null to disable icons. Search for 'completer themes' in the command palette for a command displaying available themes.
 */
export type CompleterTheme2 = CompleterTheme | CompleterTheme1;
/**
 * The identifier of a completer theme with icons which indicate the kind of completion. Set to null to disable icons. Search for 'completer themes' in the command palette for a command displaying available themes.
 */
export type CompleterTheme = string;
/**
 * The identifier of a completer theme with icons which indicate the kind of completion. Set to null to disable icons. Search for 'completer themes' in the command palette for a command displaying available themes.
 */
export type CompleterTheme1 = null;
/**
 * In case of ties when sorting completions, should the kernel completions receive higher priority than the language server completions?
 */
export type PrioritizeCompletionsFromKernel = boolean;
/**
 * Should completion filtering be case-sensitive?
 */
export type CaseSensitiveFiltering = boolean;
/**
 * Should perfect matches be included in the completion suggestions list?
 */
export type IncludePerfectMatches = boolean;
/**
 * Should matches be pre-filtered to ensure typed token is a prefix of the match?
 */
export type PreFilterMatches = boolean;
/**
 * What to display next to the completion label, one of: 'detail', 'type', 'source', 'auto'. The default 'auto' will display whichever information is available.
 */
export type TextToDisplayNextToCompletionLabel = 'detail' | 'type' | 'source' | 'auto';
/**
 * Layout of the completer, one of: 'detail-below', 'side-by-side'
 */
export type CompleterLayout = 'detail-below' | 'side-by-side';
/**
 * Disable this feature. Requires reloading JupyterLab to apply changes.
 */
export type Disable = boolean;
/**
 * LSP Completion settings.
 */
export interface CodeCompletion {
    continuousHinting?: ContinuousHinting;
    suppressContinuousHintingIn?: SuppressInvokeContinuousHintingInSpecificCodeFragments;
    suppressTriggerCharacterIn?: SuppressInvokeViaTriggerCharacterInSpecificCodeFragments;
    waitForBusyKernel?: WaitForKernelIfBusy;
    theme?: CompleterTheme2;
    kernelCompletionsFirst?: PrioritizeCompletionsFromKernel;
    caseSensitive?: CaseSensitiveFiltering;
    includePerfectMatches?: IncludePerfectMatches;
    preFilterMatches?: PreFilterMatches;
    labelExtra?: TextToDisplayNextToCompletionLabel;
    layout?: CompleterLayout;
    typesMap?: MappingOfCustomKernelTypesToValidCompletionKindNames;
    disable?: Disable;
    [k: string]: any;
}
/**
 * Mapping used for icon selection. The kernel types (keys) are case-insensitive. Accepted values are the names of CompletionItemKind and 'Kernel' literal. The defaults aim to provide good initial experience for Julia, Python and R kernels.
 */
export interface MappingOfCustomKernelTypesToValidCompletionKindNames {
    [k: string]: 'Kernel' | 'Text' | 'Method' | 'Function' | 'Constructor' | 'Field' | 'Variable' | 'Class' | 'Interface' | 'Module' | 'Property' | 'Unit' | 'Value' | 'Enum' | 'Keyword' | 'Snippet' | 'Color' | 'File' | 'Reference' | 'Folder' | 'EnumMember' | 'Constant' | 'Struct' | 'Event' | 'Operator' | 'TypeParameter';
}