<link rel="stylesheet" href="/_merged_assets/_static/noscript.css">
Atom Community Logo Atom Community API Getting Started Toggle darkmode

Signature Help GitHub

A replacement of the signature help functionality from atom-ide-ui. When you're calling a function, it can help you understand the parameters or information about the function you’re calling.

screenshot of sig-help feature

API

MarkupContent

Properties

kind

MarkupKind

value

string

Signature

Properties

documentation

(optional)
string|MarkupContent

label

string

parameters

(optional)
SignatureParameter[]

SignatureHelp

Properties

activeParameter

(optional)
null|number

activeSignature

(optional)
null|number

signatures

Signature[]

SignatureHelpProvider

Signature help is activated when:

  • upon keystroke, any provider with a matching grammar scope contains the pressed key inside its triggerCharacters set
  • the signature-help:show command is manually activated

Once signature help has been triggered, the provider will be queried immediately with the current cursor position, and then repeatedly upon cursor movements until a null/empty signature is returned.

Returned signatures will be displayed in a small datatip at the current cursor. The highest-priority provider with a non-null result will be used.

Properties

grammarScopes

readonly string[]

priority

number

triggerCharacters

(optional)
Set<string>

A set of characters that will trigger signature help when typed. If a null/empty set is provided, only manual activation of the command works.

Methods

getSignatureHelp

Parameters

editor
TextEditor
point
Point

Returns

Promise<undefined|null|SignatureHelp>

SignatureParameter

Properties

documentation

(optional)
string|MarkupContent

label

string|

MarkupKind

ParameterInformation

SignatureHelpRegistry

SignatureInformation