<link rel="stylesheet" href="/_merged_assets/_static/search/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) 
null|string|MarkupContent

label

 
string

parameters

(optional) 
SignatureParameter[]

SignatureHelp

Properties

activeParameter

(optional) 
null|number

activeSignature

(optional) 
null|number

signatures

 
Signature[]

SignatureHelpProvider

Properties

grammarScopes

 
readonly string[]

priority

 
number

triggerCharacters

(optional) 
Set<string>

Methods

getSignatureHelp

Parameters

editor
TextEditor
point
Point

Returns

Promise<undefined|null|SignatureHelp>

SignatureParameter

Properties

documentation

(optional) 
null|string|MarkupContent

label

 
string|

MarkupKind

ParameterInformation

SignatureHelpRegistry

SignatureInformation

Caught a mistake or want to contribute to the documentation? Edit this page on GitHub!