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

Find References

API

FindReferencesData

Properties

baseUri

string

referencedSymbolName

string

references

Reference[]

title

(optional)
string

defaults to 'Symbol References'

type

"data"

FindReferencesError

Properties

message

string

type

"error"

FindReferencesProvider

Methods

findReferences

findReferences will only be called if isEditorSupported previously returned true for the given Atom.TextEditor.

Parameters

editor
TextEditor
position
Point

Returns

Promise<undefined|null|FindReferencesReturn>

isEditorSupported

Return true if your provider supports finding references for the provided Atom.TextEditor.

Parameters

editor
TextEditor

Returns

boolean|Promise<boolean>

Reference

Properties

name

undefined|null|string

name of calling method/function/symbol

range

Range

uri

string

URI of the file path

FindReferencesReturn