Permalink
Fetching contributors…
Cannot retrieve contributors at this time
8817 lines (8817 sloc) 332 KB
{
"AtomEnvironment": [
{
"name": "clipboard",
"text": "clipboard",
"description": "A {Clipboard} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-clipboard",
"leftLabel": "Clipboard",
"type": "property"
},
{
"name": "commands",
"text": "commands",
"description": "A {CommandRegistry} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-commands",
"leftLabel": "CommandRegistry",
"type": "property"
},
{
"name": "config",
"text": "config",
"description": "A {Config} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-config",
"leftLabel": "Config",
"type": "property"
},
{
"name": "contextMenu",
"text": "contextMenu",
"description": "A {ContextMenuManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-contextMenu",
"leftLabel": "ContextMenuManager",
"type": "property"
},
{
"name": "deserializers",
"text": "deserializers",
"description": "A {DeserializerManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-deserializers",
"leftLabel": "DeserializerManager",
"type": "property"
},
{
"name": "grammars",
"text": "grammars",
"description": "A {GrammarRegistry} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-grammars",
"leftLabel": "GrammarRegistry",
"type": "property"
},
{
"name": "history",
"text": "history",
"description": "A {HistoryManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-history",
"leftLabel": "HistoryManager",
"type": "property"
},
{
"name": "keymaps",
"text": "keymaps",
"description": "A {KeymapManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-keymaps",
"leftLabel": "KeymapManager",
"type": "property"
},
{
"name": "menu",
"text": "menu",
"description": "A {MenuManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-menu",
"leftLabel": "MenuManager",
"type": "property"
},
{
"name": "notifications",
"text": "notifications",
"description": "A {NotificationManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-notifications",
"leftLabel": "NotificationManager",
"type": "property"
},
{
"name": "packages",
"text": "packages",
"description": "A {PackageManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-packages",
"leftLabel": "PackageManager",
"type": "property"
},
{
"name": "project",
"text": "project",
"description": "A {Project} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-project",
"leftLabel": "Project",
"type": "property"
},
{
"name": "styles",
"text": "styles",
"description": "A {StyleManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-styles",
"leftLabel": "StyleManager",
"type": "property"
},
{
"name": "textEditors",
"text": "textEditors",
"description": "A {TextEditorRegistry} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-textEditors",
"leftLabel": "TextEditorRegistry",
"type": "property"
},
{
"name": "themes",
"text": "themes",
"description": "A {ThemeManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-themes",
"leftLabel": "ThemeManager",
"type": "property"
},
{
"name": "tooltips",
"text": "tooltips",
"description": "A {TooltipManager} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-tooltips",
"leftLabel": "TooltipManager",
"type": "property"
},
{
"name": "views",
"text": "views",
"description": "A {ViewRegistry} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-views",
"leftLabel": "ViewRegistry",
"type": "property"
},
{
"name": "workspace",
"text": "workspace",
"description": "A {Workspace} instance ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-workspace",
"leftLabel": "Workspace",
"type": "property"
},
{
"name": "beep",
"text": "beep()",
"snippet": null,
"description": "Visually and audibly trigger a beep. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-beep",
"type": "method"
},
{
"name": "center",
"text": "center()",
"snippet": null,
"description": "Move current window to the center of the screen. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-center",
"type": "method"
},
{
"name": "close",
"text": "close()",
"snippet": null,
"description": "Close the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-close",
"type": "method"
},
{
"name": "confirm",
"text": null,
"snippet": "confirm(${1:options})",
"description": "A flexible way to open a dialog akin to an alert dialog.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-confirm",
"leftLabel": "Number",
"type": "method"
},
{
"name": "executeJavaScriptInDevTools",
"text": "executeJavaScriptInDevTools()",
"snippet": null,
"description": "Execute code in dev tools. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-executeJavaScriptInDevTools",
"type": "method"
},
{
"name": "focus",
"text": "focus()",
"snippet": null,
"description": "Focus the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-focus",
"type": "method"
},
{
"name": "getCurrentWindow",
"text": "getCurrentWindow()",
"snippet": null,
"description": "Get the current window ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getCurrentWindow",
"type": "method"
},
{
"name": "getLoadSettings",
"text": "getLoadSettings()",
"snippet": null,
"description": "Get the load settings for the current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getLoadSettings",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getPosition",
"text": "getPosition()",
"snippet": null,
"description": "Get the position of current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getPosition",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getReleaseChannel",
"text": "getReleaseChannel()",
"snippet": null,
"description": "Gets the release channel of the Atom application.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getReleaseChannel",
"leftLabel": "String",
"type": "method"
},
{
"name": "getSize",
"text": "getSize()",
"snippet": null,
"description": "Get the size of current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getSize",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getVersion",
"text": "getVersion()",
"snippet": null,
"description": "Get the version of the Atom application.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getVersion",
"leftLabel": "String",
"type": "method"
},
{
"name": "getWindowLoadTime",
"text": "getWindowLoadTime()",
"snippet": null,
"description": "Get the time taken to completely load the current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-getWindowLoadTime",
"leftLabel": "Number",
"type": "method"
},
{
"name": "hide",
"text": "hide()",
"snippet": null,
"description": "Hide the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-hide",
"type": "method"
},
{
"name": "inDevMode",
"text": "inDevMode()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-inDevMode",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "inSafeMode",
"text": "inSafeMode()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-inSafeMode",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "inSpecMode",
"text": "inSpecMode()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-inSpecMode",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isFullScreen",
"text": "isFullScreen()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-isFullScreen",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isMaximized",
"text": "isMaximized()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-isMaximized",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isReleasedVersion",
"text": "isReleasedVersion()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-isReleasedVersion",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "onDidBeep",
"text": null,
"snippet": "onDidBeep(${1:callback})",
"description": "Invoke the given callback whenever {::beep} is called.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-onDidBeep",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidThrowError",
"text": null,
"snippet": "onDidThrowError(${1:callback})",
"description": "Invoke the given callback whenever there is an unhandled error.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-onDidThrowError",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onWillThrowError",
"text": null,
"snippet": "onWillThrowError(${1:callback})",
"description": "Invoke the given callback when there is an unhandled error, but\nbefore the devtools pop open",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-onWillThrowError",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "open",
"text": null,
"snippet": "open(${1:params})",
"description": "Open a new Atom window using the given options.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-open",
"type": "method"
},
{
"name": "openDevTools",
"text": "openDevTools()",
"snippet": null,
"description": "Open the dev tools for the current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-openDevTools",
"leftLabel": "Promise",
"type": "method"
},
{
"name": "pickFolder",
"text": null,
"snippet": "pickFolder(${1:callback})",
"description": "Prompt the user to select one or more folders.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-pickFolder",
"type": "method"
},
{
"name": "reload",
"text": "reload()",
"snippet": null,
"description": "Reload the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-reload",
"type": "method"
},
{
"name": "restartApplication",
"text": "restartApplication()",
"snippet": null,
"description": "Relaunch the entire application. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-restartApplication",
"type": "method"
},
{
"name": "setFullScreen",
"text": "setFullScreen()",
"snippet": null,
"description": "Set the full screen state of the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-setFullScreen",
"type": "method"
},
{
"name": "setPosition",
"text": null,
"snippet": "setPosition(${1:x}, ${2:y})",
"description": "Set the position of current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-setPosition",
"type": "method"
},
{
"name": "setSize",
"text": null,
"snippet": "setSize(${1:width}, ${2:height})",
"description": "Set the size of current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-setSize",
"type": "method"
},
{
"name": "show",
"text": "show()",
"snippet": null,
"description": "Show the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-show",
"type": "method"
},
{
"name": "toggleDevTools",
"text": "toggleDevTools()",
"snippet": null,
"description": "Toggle the visibility of the dev tools for the current window.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-toggleDevTools",
"leftLabel": "Promise",
"type": "method"
},
{
"name": "toggleFullScreen",
"text": "toggleFullScreen()",
"snippet": null,
"description": "Toggle the full screen state of the current window. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-toggleFullScreen",
"type": "method"
},
{
"name": "whenShellEnvironmentLoaded",
"text": null,
"snippet": "whenShellEnvironmentLoaded(${1:callback})",
"description": "Invoke the given callback as soon as the shell environment is\nloaded (or immediately if it was already loaded).",
"descriptionMoreURL": "https://atom.io/docs/api/latest/AtomEnvironment#instance-whenShellEnvironmentLoaded",
"type": "method"
}
],
"BufferedNodeProcess": [
{
"name": "constructor",
"text": null,
"snippet": "constructor(${1:options})",
"description": "Runs the given Node script by spawning a new child process.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedNodeProcess#instance-constructor",
"type": "method"
}
],
"BufferedProcess": [
{
"name": "constructor",
"text": null,
"snippet": "constructor(${1:options})",
"description": "Runs the given command by spawning a new child process.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedProcess#instance-constructor",
"type": "method"
},
{
"name": "kill",
"text": "kill()",
"snippet": null,
"description": "Terminate the process.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedProcess#instance-kill",
"type": "method"
},
{
"name": "onWillThrowError",
"text": null,
"snippet": "onWillThrowError(${1:callback})",
"description": "Will call your callback when an error will be raised by the process.\nUsually this is due to the command not being available or not on the PATH.\nYou can call `handle()` on the object passed to your callback to indicate\nthat you have handled this error.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/BufferedProcess#instance-onWillThrowError",
"leftLabel": "Disposable",
"type": "method"
}
],
"Clipboard": [
{
"name": "read",
"text": "read()",
"snippet": null,
"description": "Read the text from the clipboard.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Clipboard#instance-read",
"leftLabel": "String",
"type": "method"
},
{
"name": "readWithMetadata",
"text": "readWithMetadata()",
"snippet": null,
"description": "Read the text from the clipboard and return both the text and the\nassociated metadata.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Clipboard#instance-readWithMetadata",
"leftLabel": "Object",
"type": "method"
},
{
"name": "write",
"text": null,
"snippet": "write(${1:text}, ${2:metadata})",
"description": "Write the given text to the clipboard.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Clipboard#instance-write",
"type": "method"
}
],
"Color": [
{
"name": "toHexString",
"text": "toHexString()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Color#instance-toHexString",
"leftLabel": "String",
"type": "method"
},
{
"name": "toRGBAString",
"text": "toRGBAString()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Color#instance-toRGBAString",
"leftLabel": "String",
"type": "method"
}
],
"CommandRegistry": [
{
"name": "add",
"text": "add()",
"snippet": null,
"description": "Add one or more command listeners associated with a selector.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-add",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "dispatch",
"text": null,
"snippet": "dispatch(${1:target}, ${2:commandName})",
"description": "Simulate the dispatch of a command on a DOM node.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-dispatch",
"type": "method"
},
{
"name": "findCommands",
"text": null,
"snippet": "findCommands(${1:params})",
"description": "Find all registered commands matching a query.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-findCommands",
"leftLabel": "Array",
"type": "method"
},
{
"name": "onDidDispatch",
"text": null,
"snippet": "onDidDispatch(${1:callback})",
"description": "Invoke the given callback after dispatching a command event.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-onDidDispatch",
"type": "method"
},
{
"name": "onWillDispatch",
"text": null,
"snippet": "onWillDispatch(${1:callback})",
"description": "Invoke the given callback before dispatching a command event.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CommandRegistry#instance-onWillDispatch",
"type": "method"
}
],
"CompositeDisposable": [
{
"name": "add",
"text": null,
"snippet": "add(${1:...disposables})",
"description": "Add disposables to be disposed when the composite is disposed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-add",
"type": "method"
},
{
"name": "clear",
"text": "clear()",
"snippet": null,
"description": "Clear all disposables. They will not be disposed by the next call\nto dispose. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-clear",
"type": "method"
},
{
"name": "constructor",
"text": "constructor()",
"snippet": null,
"description": "Construct an instance, optionally with one or more disposables ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-constructor",
"type": "method"
},
{
"name": "delete",
"text": "delete()",
"snippet": null,
"description": "Alias to {CompositeDisposable::remove} ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-delete",
"type": "method"
},
{
"name": "dispose",
"text": "dispose()",
"snippet": null,
"description": "Dispose all disposables added to this composite disposable.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-dispose",
"type": "method"
},
{
"name": "remove",
"text": null,
"snippet": "remove(${1:disposable})",
"description": "Remove a previously added disposable.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/CompositeDisposable#instance-remove",
"type": "method"
}
],
"Config": [
{
"name": "get",
"text": null,
"snippet": "get(${1:keyPath}, ${2:options})",
"description": "Retrieves the setting for the given key.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-get",
"leftLabel": null,
"type": "method"
},
{
"name": "getAll",
"text": null,
"snippet": "getAll(${1:keyPath}, ${2:options})",
"description": "Get all of the values for the given key-path, along with their\nassociated scope selector.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getAll",
"leftLabel": "Array",
"type": "method"
},
{
"name": "getSchema",
"text": null,
"snippet": "getSchema(${1:keyPath})",
"description": "Retrieve the schema for a specific key path. The schema will tell\nyou what type the keyPath expects, and other metadata about the config\noption.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getSchema",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getSources",
"text": "getSources()",
"snippet": null,
"description": "Get an {Array} of all of the `source` {String}s with which\nsettings have been added via {::set}. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getSources",
"type": "method"
},
{
"name": "getUserConfigPath",
"text": "getUserConfigPath()",
"snippet": null,
"description": "Get the {String} path to the config file being used. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-getUserConfigPath",
"type": "method"
},
{
"name": "observe",
"text": null,
"snippet": "observe(${1:keyPath}, ${2:options}, ${3:callback})",
"description": "Add a listener for changes to a given key path. This is different\nthan {::onDidChange} in that it will immediately call your callback with the\ncurrent value of the config entry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-observe",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidChange",
"text": null,
"snippet": "onDidChange(${1:keyPath}, ${2:options}, ${3:callback})",
"description": "Add a listener for changes to a given key path. If `keyPath` is\nnot specified, your callback will be called on changes to any key.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-onDidChange",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "set",
"text": null,
"snippet": "set(${1:keyPath}, ${2:value}, ${3:options})",
"description": "Sets the value for a configuration setting.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-set",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "transact",
"text": null,
"snippet": "transact(${1:callback})",
"description": "Suppress calls to handler functions registered with {::onDidChange}\nand {::observe} for the duration of `callback`. After `callback` executes,\nhandlers will be called once if the value for their key-path has changed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-transact",
"type": "method"
},
{
"name": "unset",
"text": null,
"snippet": "unset(${1:keyPath}, ${2:options})",
"description": "Restore the setting at `keyPath` to its default value.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Config#instance-unset",
"type": "method"
}
],
"ContextMenuManager": [
{
"name": "add",
"text": null,
"snippet": "add(${1:itemsBySelector})",
"description": "Add context menu items scoped by CSS selectors.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/ContextMenuManager#instance-add",
"leftLabel": "Disposable",
"type": "method"
}
],
"Cursor": [
{
"name": "clearSelection",
"text": "clearSelection()",
"snippet": null,
"description": "Deselects the current selection.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-clearSelection",
"type": "method"
},
{
"name": "compare",
"text": null,
"snippet": "compare(${1:otherCursor})",
"description": "Compare this cursor's buffer position to another cursor's buffer position.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-compare",
"type": "method"
},
{
"name": "getBeginningOfCurrentWordBufferPosition",
"text": null,
"snippet": "getBeginningOfCurrentWordBufferPosition(${1:options})",
"description": "Retrieves the buffer position of where the current word starts.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBeginningOfCurrentWordBufferPosition",
"leftLabel": "Range",
"type": "method"
},
{
"name": "getBeginningOfNextWordBufferPosition",
"text": null,
"snippet": "getBeginningOfNextWordBufferPosition(${1:options})",
"description": "Retrieves the buffer position of where the next word starts.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBeginningOfNextWordBufferPosition",
"leftLabel": "Range",
"type": "method"
},
{
"name": "getBufferColumn",
"text": "getBufferColumn()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBufferColumn",
"leftLabel": null,
"type": "method"
},
{
"name": "getBufferPosition",
"text": "getBufferPosition()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBufferPosition",
"leftLabel": null,
"type": "method"
},
{
"name": "getBufferRow",
"text": "getBufferRow()",
"snippet": null,
"description": "Retrieves the cursor's current buffer row.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getBufferRow",
"type": "method"
},
{
"name": "getCurrentBufferLine",
"text": "getCurrentBufferLine()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentBufferLine",
"leftLabel": null,
"type": "method"
},
{
"name": "getCurrentLineBufferRange",
"text": null,
"snippet": "getCurrentLineBufferRange(${1:options})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentLineBufferRange",
"leftLabel": null,
"type": "method"
},
{
"name": "getCurrentParagraphBufferRange",
"text": "getCurrentParagraphBufferRange()",
"snippet": null,
"description": "Retrieves the range for the current paragraph.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentParagraphBufferRange",
"leftLabel": "Range",
"type": "method"
},
{
"name": "getCurrentWordBufferRange",
"text": null,
"snippet": "getCurrentWordBufferRange(${1:options})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentWordBufferRange",
"leftLabel": null,
"type": "method"
},
{
"name": "getCurrentWordPrefix",
"text": "getCurrentWordPrefix()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getCurrentWordPrefix",
"leftLabel": null,
"type": "method"
},
{
"name": "getEndOfCurrentWordBufferPosition",
"text": null,
"snippet": "getEndOfCurrentWordBufferPosition(${1:options})",
"description": "Retrieves the buffer position of where the current word ends.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getEndOfCurrentWordBufferPosition",
"leftLabel": "Range",
"type": "method"
},
{
"name": "getIndentLevel",
"text": "getIndentLevel()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getIndentLevel",
"leftLabel": null,
"type": "method"
},
{
"name": "getMarker",
"text": "getMarker()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getMarker",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "getNextWordBoundaryBufferPosition",
"text": null,
"snippet": "getNextWordBoundaryBufferPosition(${1:options})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getNextWordBoundaryBufferPosition",
"leftLabel": null,
"type": "method"
},
{
"name": "getPreviousWordBoundaryBufferPosition",
"text": null,
"snippet": "getPreviousWordBoundaryBufferPosition(${1:options})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getPreviousWordBoundaryBufferPosition",
"leftLabel": null,
"type": "method"
},
{
"name": "getScopeDescriptor",
"text": "getScopeDescriptor()",
"snippet": null,
"description": "Retrieves the scope descriptor for the cursor's current position.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScopeDescriptor",
"leftLabel": "ScopeDescriptor",
"type": "method"
},
{
"name": "getScreenColumn",
"text": "getScreenColumn()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScreenColumn",
"leftLabel": null,
"type": "method"
},
{
"name": "getScreenPosition",
"text": "getScreenPosition()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScreenPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getScreenRow",
"text": "getScreenRow()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-getScreenRow",
"leftLabel": null,
"type": "method"
},
{
"name": "hasPrecedingCharactersOnLine",
"text": "hasPrecedingCharactersOnLine()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-hasPrecedingCharactersOnLine",
"leftLabel": null,
"type": "method"
},
{
"name": "isAtBeginningOfLine",
"text": "isAtBeginningOfLine()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isAtBeginningOfLine",
"leftLabel": null,
"type": "method"
},
{
"name": "isAtEndOfLine",
"text": "isAtEndOfLine()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isAtEndOfLine",
"leftLabel": null,
"type": "method"
},
{
"name": "isBetweenWordAndNonWord",
"text": "isBetweenWordAndNonWord()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isBetweenWordAndNonWord",
"leftLabel": null,
"type": "method"
},
{
"name": "isInsideWord",
"text": null,
"snippet": "isInsideWord(${1:options})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isInsideWord",
"leftLabel": null,
"type": "method"
},
{
"name": "isLastCursor",
"text": "isLastCursor()",
"snippet": null,
"description": "Identifies if this cursor is the last in the {TextEditor}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isLastCursor",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isSurroundedByWhitespace",
"text": "isSurroundedByWhitespace()",
"snippet": null,
"description": "Identifies if the cursor is surrounded by whitespace.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-isSurroundedByWhitespace",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "moveDown",
"text": null,
"snippet": "moveDown(${1:rowCount}, ${2:options})",
"description": "Moves the cursor down one screen row.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveDown",
"type": "method"
},
{
"name": "moveLeft",
"text": null,
"snippet": "moveLeft(${1:columnCount}, ${2:options})",
"description": "Moves the cursor left one screen column.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveLeft",
"type": "method"
},
{
"name": "moveRight",
"text": null,
"snippet": "moveRight(${1:columnCount}, ${2:options})",
"description": "Moves the cursor right one screen column.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveRight",
"type": "method"
},
{
"name": "moveToBeginningOfLine",
"text": "moveToBeginningOfLine()",
"snippet": null,
"description": "Moves the cursor to the beginning of the buffer line.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfLine",
"type": "method"
},
{
"name": "moveToBeginningOfNextParagraph",
"text": "moveToBeginningOfNextParagraph()",
"snippet": null,
"description": "Moves the cursor to the beginning of the next paragraph",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfNextParagraph",
"type": "method"
},
{
"name": "moveToBeginningOfNextWord",
"text": "moveToBeginningOfNextWord()",
"snippet": null,
"description": "Moves the cursor to the beginning of the next word.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfNextWord",
"type": "method"
},
{
"name": "moveToBeginningOfPreviousParagraph",
"text": "moveToBeginningOfPreviousParagraph()",
"snippet": null,
"description": "Moves the cursor to the beginning of the previous paragraph",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfPreviousParagraph",
"type": "method"
},
{
"name": "moveToBeginningOfScreenLine",
"text": "moveToBeginningOfScreenLine()",
"snippet": null,
"description": "Moves the cursor to the beginning of the line.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfScreenLine",
"type": "method"
},
{
"name": "moveToBeginningOfWord",
"text": "moveToBeginningOfWord()",
"snippet": null,
"description": "Moves the cursor to the beginning of the word.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBeginningOfWord",
"type": "method"
},
{
"name": "moveToBottom",
"text": "moveToBottom()",
"snippet": null,
"description": "Moves the cursor to the bottom of the buffer.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToBottom",
"type": "method"
},
{
"name": "moveToEndOfLine",
"text": "moveToEndOfLine()",
"snippet": null,
"description": "Moves the cursor to the end of the buffer line.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToEndOfLine",
"type": "method"
},
{
"name": "moveToEndOfScreenLine",
"text": "moveToEndOfScreenLine()",
"snippet": null,
"description": "Moves the cursor to the end of the line.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToEndOfScreenLine",
"type": "method"
},
{
"name": "moveToEndOfWord",
"text": "moveToEndOfWord()",
"snippet": null,
"description": "Moves the cursor to the end of the word.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToEndOfWord",
"type": "method"
},
{
"name": "moveToFirstCharacterOfLine",
"text": "moveToFirstCharacterOfLine()",
"snippet": null,
"description": "Moves the cursor to the beginning of the first character in the\nline.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToFirstCharacterOfLine",
"type": "method"
},
{
"name": "moveToNextSubwordBoundary",
"text": "moveToNextSubwordBoundary()",
"snippet": null,
"description": "Moves the cursor to the next subword boundary.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToNextSubwordBoundary",
"type": "method"
},
{
"name": "moveToNextWordBoundary",
"text": "moveToNextWordBoundary()",
"snippet": null,
"description": "Moves the cursor to the next word boundary.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToNextWordBoundary",
"type": "method"
},
{
"name": "moveToPreviousSubwordBoundary",
"text": "moveToPreviousSubwordBoundary()",
"snippet": null,
"description": "Moves the cursor to the previous subword boundary.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToPreviousSubwordBoundary",
"type": "method"
},
{
"name": "moveToPreviousWordBoundary",
"text": "moveToPreviousWordBoundary()",
"snippet": null,
"description": "Moves the cursor to the previous word boundary.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToPreviousWordBoundary",
"type": "method"
},
{
"name": "moveToTop",
"text": "moveToTop()",
"snippet": null,
"description": "Moves the cursor to the top of the buffer.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveToTop",
"type": "method"
},
{
"name": "moveUp",
"text": null,
"snippet": "moveUp(${1:rowCount}, ${2:options})",
"description": "Moves the cursor up one screen row.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-moveUp",
"type": "method"
},
{
"name": "onDidChangePosition",
"text": null,
"snippet": "onDidChangePosition(${1:callback})",
"description": "Calls your `callback` when the cursor has been moved.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-onDidChangePosition",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroy",
"text": null,
"snippet": "onDidDestroy(${1:callback})",
"description": "Calls your `callback` when the cursor is destroyed",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-onDidDestroy",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "setBufferPosition",
"text": null,
"snippet": "setBufferPosition(${1:bufferPosition}, ${2:options})",
"description": "Moves a cursor to a given buffer position.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-setBufferPosition",
"type": "method"
},
{
"name": "setScreenPosition",
"text": null,
"snippet": "setScreenPosition(${1:screenPosition}, ${2:options})",
"description": "Moves a cursor to a given screen position.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-setScreenPosition",
"type": "method"
},
{
"name": "skipLeadingWhitespace",
"text": "skipLeadingWhitespace()",
"snippet": null,
"description": "Moves the cursor to the beginning of the buffer line, skipping all\nwhitespace.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-skipLeadingWhitespace",
"type": "method"
},
{
"name": "subwordRegExp",
"text": null,
"snippet": "subwordRegExp(${1:options})",
"description": "Get the RegExp used by the cursor to determine what a \"subword\" is.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-subwordRegExp",
"leftLabel": "RegExp",
"type": "method"
},
{
"name": "wordRegExp",
"text": null,
"snippet": "wordRegExp(${1:options})",
"description": "Get the RegExp used by the cursor to determine what a \"word\" is.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Cursor#instance-wordRegExp",
"leftLabel": "RegExp",
"type": "method"
}
],
"Decoration": [
{
"name": "destroy",
"text": "destroy()",
"snippet": null,
"description": "Destroy this marker decoration.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-destroy",
"type": "method"
},
{
"name": "getId",
"text": "getId()",
"snippet": null,
"description": "An id unique across all {Decoration} objects",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-getId",
"type": "method"
},
{
"name": "getMarker",
"text": "getMarker()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-getMarker",
"leftLabel": "Decoration",
"type": "method"
},
{
"name": "getProperties",
"text": "getProperties()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-getProperties",
"leftLabel": "Decoration",
"type": "method"
},
{
"name": "isType",
"text": null,
"snippet": "isType(${1:type})",
"description": "Check if this decoration is of type `type`",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-isType",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "onDidChangeProperties",
"text": null,
"snippet": "onDidChangeProperties(${1:callback})",
"description": "When the {Decoration} is updated via {Decoration::update}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-onDidChangeProperties",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroy",
"text": null,
"snippet": "onDidDestroy(${1:callback})",
"description": "Invoke the given callback when the {Decoration} is destroyed",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-onDidDestroy",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "setProperties",
"text": null,
"snippet": "setProperties(${1:newProperties})",
"description": "Update the marker with new Properties. Allows you to change the decoration's class.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Decoration#instance-setProperties",
"type": "method"
}
],
"DeserializerManager": [
{
"name": "add",
"text": null,
"snippet": "add(${1:deserializers})",
"description": "Register the given class(es) as deserializers.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DeserializerManager#instance-add",
"type": "method"
},
{
"name": "deserialize",
"text": null,
"snippet": "deserialize(${1:state})",
"description": "Deserialize the state and params.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DeserializerManager#instance-deserialize",
"type": "method"
}
],
"Directory": [
{
"name": "constructor",
"text": null,
"snippet": "constructor(${1:directoryPath}, ${2:symlink})",
"description": "Configures a new Directory instance, no files are accessed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-constructor",
"type": "method"
},
{
"name": "contains",
"text": null,
"snippet": "contains(${1:pathToCheck})",
"description": "Determines if the given path (real or symbolic) is inside this\ndirectory. This method does not actually check if the path exists, it just\nchecks if the path is under this directory.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-contains",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "create",
"text": null,
"snippet": "create(${1:mode})",
"description": "Creates the directory on disk that corresponds to `::getPath()` if\nno such directory already exists.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-create",
"leftLabel": "Promise",
"type": "method"
},
{
"name": "exists",
"text": "exists()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-exists",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "existsSync",
"text": "existsSync()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-existsSync",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "getBaseName",
"text": "getBaseName()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getBaseName",
"leftLabel": "String",
"type": "method"
},
{
"name": "getEntries",
"text": null,
"snippet": "getEntries(${1:callback})",
"description": "Reads file entries in this directory from disk asynchronously.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getEntries",
"type": "method"
},
{
"name": "getEntriesSync",
"text": "getEntriesSync()",
"snippet": null,
"description": "Reads file entries in this directory from disk synchronously.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getEntriesSync",
"leftLabel": "Array",
"type": "method"
},
{
"name": "getFile",
"text": null,
"snippet": "getFile(${1:filename})",
"description": "Traverse within this Directory to a child File. This method doesn't\nactually check to see if the File exists, it just creates the File object.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getFile",
"leftLabel": "File",
"type": "method"
},
{
"name": "getParent",
"text": "getParent()",
"snippet": null,
"description": "Traverse to the parent directory.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getParent",
"leftLabel": "Directory",
"type": "method"
},
{
"name": "getPath",
"text": "getPath()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getPath",
"leftLabel": "String",
"type": "method"
},
{
"name": "getRealPathSync",
"text": "getRealPathSync()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getRealPathSync",
"leftLabel": "String",
"type": "method"
},
{
"name": "getSubdirectory",
"text": null,
"snippet": "getSubdirectory(${1:dirname})",
"description": "Traverse within this a Directory to a child Directory. This method\ndoesn't actually check to see if the Directory exists, it just creates the\nDirectory object.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-getSubdirectory",
"leftLabel": "Directory",
"type": "method"
},
{
"name": "isDirectory",
"text": "isDirectory()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isDirectory",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isFile",
"text": "isFile()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isFile",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isRoot",
"text": "isRoot()",
"snippet": null,
"description": "Return a {Boolean}, true if this {Directory} is the root directory\nof the filesystem, or false if it isn't. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isRoot",
"type": "method"
},
{
"name": "isSymbolicLink",
"text": "isSymbolicLink()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-isSymbolicLink",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "onDidChange",
"text": null,
"snippet": "onDidChange(${1:callback})",
"description": "Invoke the given callback when the directory's contents change.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-onDidChange",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "relativize",
"text": "relativize()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Directory#instance-relativize",
"leftLabel": "String",
"type": "method"
}
],
"DisplayMarker": [
{
"name": "clearTail",
"text": "clearTail()",
"snippet": null,
"description": "Removes the marker's tail. After calling the marker's head position\nwill be reported as its current tail position until the tail is planted\nagain. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-clearTail",
"type": "method"
},
{
"name": "compare",
"text": null,
"snippet": "compare(${1:other})",
"description": "Compares this marker to another based on their ranges.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-compare",
"leftLabel": "Number",
"type": "method"
},
{
"name": "copy",
"text": null,
"snippet": "copy(${1:properties})",
"description": "Creates and returns a new {DisplayMarker} with the same properties as\nthis marker.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-copy",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "destroy",
"text": "destroy()",
"snippet": null,
"description": "Destroys the marker, causing it to emit the 'destroyed' event. Once\ndestroyed, a marker cannot be restored by undo/redo operations. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-destroy",
"type": "method"
},
{
"name": "getBufferRange",
"text": "getBufferRange()",
"snippet": null,
"description": "Gets the buffer range of this marker.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getBufferRange",
"leftLabel": "Range",
"type": "method"
},
{
"name": "getEndBufferPosition",
"text": "getEndBufferPosition()",
"snippet": null,
"description": "Retrieves the buffer position of the marker's end. This will always be\ngreater than or equal to the result of {DisplayMarker::getStartBufferPosition}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getEndBufferPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getEndScreenPosition",
"text": null,
"snippet": "getEndScreenPosition(${1:options})",
"description": "Retrieves the screen position of the marker's end. This will always be\ngreater than or equal to the result of {DisplayMarker::getStartScreenPosition}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getEndScreenPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getHeadBufferPosition",
"text": "getHeadBufferPosition()",
"snippet": null,
"description": "Retrieves the buffer position of the marker's head.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getHeadBufferPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getHeadScreenPosition",
"text": null,
"snippet": "getHeadScreenPosition(${1:options})",
"description": "Retrieves the screen position of the marker's head.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getHeadScreenPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getInvalidationStrategy",
"text": "getInvalidationStrategy()",
"snippet": null,
"description": "Get the invalidation strategy for this marker.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getInvalidationStrategy",
"leftLabel": "String",
"type": "method"
},
{
"name": "getProperties",
"text": "getProperties()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getProperties",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getScreenRange",
"text": "getScreenRange()",
"snippet": null,
"description": "Gets the screen range of this marker.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getScreenRange",
"leftLabel": "Range",
"type": "method"
},
{
"name": "getStartBufferPosition",
"text": "getStartBufferPosition()",
"snippet": null,
"description": "Retrieves the buffer position of the marker's start. This will always be\nless than or equal to the result of {DisplayMarker::getEndBufferPosition}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getStartBufferPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getStartScreenPosition",
"text": null,
"snippet": "getStartScreenPosition(${1:options})",
"description": "Retrieves the screen position of the marker's start. This will always be\nless than or equal to the result of {DisplayMarker::getEndScreenPosition}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getStartScreenPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getTailBufferPosition",
"text": "getTailBufferPosition()",
"snippet": null,
"description": "Retrieves the buffer position of the marker's tail.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getTailBufferPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "getTailScreenPosition",
"text": null,
"snippet": "getTailScreenPosition(${1:options})",
"description": "Retrieves the screen position of the marker's tail.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-getTailScreenPosition",
"leftLabel": "Point",
"type": "method"
},
{
"name": "hasTail",
"text": "hasTail()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-hasTail",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isDestroyed",
"text": "isDestroyed()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isDestroyed",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isEqual",
"text": null,
"snippet": "isEqual(${1:other})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isEqual",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isExclusive",
"text": "isExclusive()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isExclusive",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isReversed",
"text": "isReversed()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isReversed",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isValid",
"text": "isValid()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-isValid",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "matchesProperties",
"text": "matchesProperties()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-matchesProperties",
"leftLabel": null,
"type": "method"
},
{
"name": "onDidChange",
"text": null,
"snippet": "onDidChange(${1:callback})",
"description": "Invoke the given callback when the state of the marker changes.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-onDidChange",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroy",
"text": null,
"snippet": "onDidDestroy(${1:callback})",
"description": "Invoke the given callback when the marker is destroyed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-onDidDestroy",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "plantTail",
"text": "plantTail()",
"snippet": null,
"description": "Plants the marker's tail at the current head position. After calling\nthe marker's tail position will be its head position at the time of the\ncall, regardless of where the marker's head is moved. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-plantTail",
"type": "method"
},
{
"name": "setBufferRange",
"text": null,
"snippet": "setBufferRange(${1:bufferRange}, ${2:properties})",
"description": "Modifies the buffer range of this marker.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setBufferRange",
"type": "method"
},
{
"name": "setHeadBufferPosition",
"text": null,
"snippet": "setHeadBufferPosition(${1:bufferPosition})",
"description": "Sets the buffer position of the marker's head.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setHeadBufferPosition",
"type": "method"
},
{
"name": "setHeadScreenPosition",
"text": null,
"snippet": "setHeadScreenPosition(${1:screenPosition}, ${2:options})",
"description": "Sets the screen position of the marker's head.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setHeadScreenPosition",
"type": "method"
},
{
"name": "setProperties",
"text": null,
"snippet": "setProperties(${1:properties})",
"description": "Merges an {Object} containing new properties into the marker's\nexisting properties.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setProperties",
"type": "method"
},
{
"name": "setScreenRange",
"text": null,
"snippet": "setScreenRange(${1:screenRange}, ${2:options})",
"description": "Modifies the screen range of this marker.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setScreenRange",
"type": "method"
},
{
"name": "setTailBufferPosition",
"text": null,
"snippet": "setTailBufferPosition(${1:bufferPosition})",
"description": "Sets the buffer position of the marker's tail.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setTailBufferPosition",
"type": "method"
},
{
"name": "setTailScreenPosition",
"text": null,
"snippet": "setTailScreenPosition(${1:screenPosition}, ${2:options})",
"description": "Sets the screen position of the marker's tail.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarker#instance-setTailScreenPosition",
"type": "method"
}
],
"DisplayMarkerLayer": [
{
"name": "clear",
"text": "clear()",
"snippet": null,
"description": "Destroy all markers in this layer. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-clear",
"type": "method"
},
{
"name": "destroy",
"text": "destroy()",
"snippet": null,
"description": "Destroy this layer. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-destroy",
"type": "method"
},
{
"name": "findMarkers",
"text": null,
"snippet": "findMarkers(${1:properties})",
"description": "Find markers in the layer conforming to the given parameters.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-findMarkers",
"leftLabel": "Array",
"type": "method"
},
{
"name": "getMarker",
"text": "getMarker()",
"snippet": null,
"description": "Get an existing marker by its id.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-getMarker",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "getMarkerCount",
"text": "getMarkerCount()",
"snippet": null,
"description": "Get the number of markers in the marker layer.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-getMarkerCount",
"leftLabel": "Number",
"type": "method"
},
{
"name": "getMarkers",
"text": "getMarkers()",
"snippet": null,
"description": "Get all markers in the layer.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-getMarkers",
"leftLabel": "Array",
"type": "method"
},
{
"name": "isDestroyed",
"text": "isDestroyed()",
"snippet": null,
"description": "Determine whether this layer has been destroyed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-isDestroyed",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "markBufferPosition",
"text": null,
"snippet": "markBufferPosition(${1:bufferPosition}, ${2:options})",
"description": "Create a marker on this layer with its head at the given buffer\nposition and no tail.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markBufferPosition",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "markBufferRange",
"text": null,
"snippet": "markBufferRange(${1:range}, ${2:options})",
"description": "Create a marker with the given buffer range.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markBufferRange",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "markScreenPosition",
"text": null,
"snippet": "markScreenPosition(${1:screenPosition}, ${2:options})",
"description": "Create a marker on this layer with its head at the given screen\nposition and no tail.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markScreenPosition",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "markScreenRange",
"text": null,
"snippet": "markScreenRange(${1:range}, ${2:options})",
"description": "Create a marker with the given screen range.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-markScreenRange",
"leftLabel": "DisplayMarker",
"type": "method"
},
{
"name": "onDidCreateMarker",
"text": null,
"snippet": "onDidCreateMarker(${1:callback})",
"description": "Subscribe to be notified synchronously whenever markers are created\non this layer. *Avoid this method for optimal performance when interacting\nwith layers that could contain large numbers of markers.*",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-onDidCreateMarker",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroy",
"text": "onDidDestroy()",
"snippet": null,
"description": "Subscribe to be notified synchronously when this layer is destroyed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-onDidDestroy",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidUpdate",
"text": null,
"snippet": "onDidUpdate(${1:callback})",
"description": "Subscribe to be notified asynchronously whenever markers are\ncreated, updated, or destroyed on this layer. *Prefer this method for\noptimal performance when interacting with layers that could contain large\nnumbers of markers.*",
"descriptionMoreURL": "https://atom.io/docs/api/latest/DisplayMarkerLayer#instance-onDidUpdate",
"leftLabel": "Disposable",
"type": "method"
}
],
"Disposable": [
{
"name": "constructor",
"text": null,
"snippet": "constructor(${1:disposalAction})",
"description": "Construct a Disposable",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Disposable#instance-constructor",
"type": "method"
},
{
"name": "dispose",
"text": "dispose()",
"snippet": null,
"description": "Perform the disposal action, indicating that the resource associated\nwith this disposable is no longer needed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Disposable#instance-dispose",
"type": "method"
}
],
"Dock": [
{
"name": "activate",
"text": "activate()",
"snippet": null,
"description": "Show the dock and focus its active {Pane}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-activate",
"type": "method"
},
{
"name": "activateNextPane",
"text": "activateNextPane()",
"snippet": null,
"description": "Make the next pane active.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-activateNextPane",
"type": "method"
},
{
"name": "activatePreviousPane",
"text": "activatePreviousPane()",
"snippet": null,
"description": "Make the previous pane active.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-activatePreviousPane",
"type": "method"
},
{
"name": "getActivePane",
"text": "getActivePane()",
"snippet": null,
"description": "Get the active {Pane}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getActivePane",
"leftLabel": "Pane",
"type": "method"
},
{
"name": "getActivePaneItem",
"text": "getActivePaneItem()",
"snippet": null,
"description": "Get the active {Pane}'s active item.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getActivePaneItem",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getPaneItems",
"text": "getPaneItems()",
"snippet": null,
"description": "Get all pane items in the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getPaneItems",
"leftLabel": "Array",
"type": "method"
},
{
"name": "getPanes",
"text": "getPanes()",
"snippet": null,
"description": "Get all panes in the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-getPanes",
"leftLabel": "Array",
"type": "method"
},
{
"name": "hide",
"text": "hide()",
"snippet": null,
"description": "Hide the dock and activate the {WorkspaceCenter} if the dock was\nwas previously focused.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-hide",
"type": "method"
},
{
"name": "isVisible",
"text": "isVisible()",
"snippet": null,
"description": "Check if the dock is visible.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-isVisible",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "observeActivePane",
"text": null,
"snippet": "observeActivePane(${1:callback})",
"description": "Invoke the given callback with the current active pane and when\nthe active pane changes.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observeActivePane",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "observeActivePaneItem",
"text": null,
"snippet": "observeActivePaneItem(${1:callback})",
"description": "Invoke the given callback with the current active pane item and\nwith all future active pane items in the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observeActivePaneItem",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "observePaneItems",
"text": null,
"snippet": "observePaneItems(${1:callback})",
"description": "Invoke the given callback with all current and future panes items\nin the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observePaneItems",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "observePanes",
"text": null,
"snippet": "observePanes(${1:callback})",
"description": "Invoke the given callback with all current and future panes in the\ndock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observePanes",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "observeVisible",
"text": null,
"snippet": "observeVisible(${1:callback})",
"description": "Invoke the given callback with the current and all future visibilities of the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-observeVisible",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidAddPane",
"text": null,
"snippet": "onDidAddPane(${1:callback})",
"description": "Invoke the given callback when a pane is added to the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidAddPane",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidAddPaneItem",
"text": null,
"snippet": "onDidAddPaneItem(${1:callback})",
"description": "Invoke the given callback when a pane item is added to the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidAddPaneItem",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidChangeActivePane",
"text": null,
"snippet": "onDidChangeActivePane(${1:callback})",
"description": "Invoke the given callback when the active pane changes.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidChangeActivePane",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidChangeActivePaneItem",
"text": null,
"snippet": "onDidChangeActivePaneItem(${1:callback})",
"description": "Invoke the given callback when the active pane item changes.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidChangeActivePaneItem",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidChangeVisible",
"text": null,
"snippet": "onDidChangeVisible(${1:callback})",
"description": "Invoke the given callback when the visibility of the dock changes.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidChangeVisible",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroyPane",
"text": null,
"snippet": "onDidDestroyPane(${1:callback})",
"description": "Invoke the given callback when a pane is destroyed in the dock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidDestroyPane",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroyPaneItem",
"text": null,
"snippet": "onDidDestroyPaneItem(${1:callback})",
"description": "Invoke the given callback when a pane item is destroyed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidDestroyPaneItem",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidStopChangingActivePaneItem",
"text": null,
"snippet": "onDidStopChangingActivePaneItem(${1:callback})",
"description": "Invoke the given callback when the active pane item stops\nchanging.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onDidStopChangingActivePaneItem",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onWillDestroyPane",
"text": null,
"snippet": "onWillDestroyPane(${1:callback})",
"description": "Invoke the given callback before a pane is destroyed in the\ndock.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onWillDestroyPane",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onWillDestroyPaneItem",
"text": null,
"snippet": "onWillDestroyPaneItem(${1:callback})",
"description": "Invoke the given callback when a pane item is about to be\ndestroyed, before the user is prompted to save it.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-onWillDestroyPaneItem",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "show",
"text": "show()",
"snippet": null,
"description": "Show the dock without focusing it.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-show",
"type": "method"
},
{
"name": "toggle",
"text": "toggle()",
"snippet": null,
"description": "Toggle the dock's visibility without changing the {Workspace}'s\nactive pane container.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Dock#instance-toggle",
"type": "method"
}
],
"Emitter": [
{
"name": "clear",
"text": "clear()",
"snippet": null,
"description": "Clear out any existing subscribers. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-clear",
"type": "method"
},
{
"name": "constructor",
"text": "constructor()",
"snippet": null,
"description": "Construct an emitter.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-constructor",
"type": "method"
},
{
"name": "dispose",
"text": "dispose()",
"snippet": null,
"description": "Unsubscribe all handlers. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-dispose",
"type": "method"
},
{
"name": "emit",
"text": null,
"snippet": "emit(${1:eventName}, ${2:value})",
"description": "Invoke handlers registered via {::on} for the given event name.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-emit",
"type": "method"
},
{
"name": "on",
"text": null,
"snippet": "on(${1:eventName}, ${2:handler})",
"description": "Register the given handler function to be invoked whenever events by\nthe given name are emitted via {::emit}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-on",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "once",
"text": null,
"snippet": "once(${1:eventName}, ${2:handler})",
"description": "Register the given handler function to be invoked the next time an\nevents with the given name is emitted via {::emit}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-once",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "preempt",
"text": null,
"snippet": "preempt(${1:eventName}, ${2:handler})",
"description": "Register the given handler function to be invoked *before* all\nother handlers existing at the time of subscription whenever events by the\ngiven name are emitted via {::emit}.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Emitter#instance-preempt",
"leftLabel": "Disposable",
"type": "method"
}
],
"File": [
{
"name": "constructor",
"text": null,
"snippet": "constructor(${1:filePath}, ${2:symlink})",
"description": "Configures a new File instance, no files are accessed.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-constructor",
"type": "method"
},
{
"name": "create",
"text": "create()",
"snippet": null,
"description": "Creates the file on disk that corresponds to `::getPath()` if no\nsuch file already exists.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-create",
"leftLabel": "Promise",
"type": "method"
},
{
"name": "createReadStream",
"text": "createReadStream()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-createReadStream",
"leftLabel": null,
"type": "method"
},
{
"name": "createWriteStream",
"text": "createWriteStream()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-createWriteStream",
"leftLabel": null,
"type": "method"
},
{
"name": "exists",
"text": "exists()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-exists",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "existsSync",
"text": "existsSync()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-existsSync",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "getBaseName",
"text": "getBaseName()",
"snippet": null,
"description": "Return the {String} filename without any directory information. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getBaseName",
"type": "method"
},
{
"name": "getDigest",
"text": "getDigest()",
"snippet": null,
"description": "Get the SHA-1 digest of this file",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getDigest",
"leftLabel": "String",
"type": "method"
},
{
"name": "getDigestSync",
"text": "getDigestSync()",
"snippet": null,
"description": "Get the SHA-1 digest of this file",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getDigestSync",
"leftLabel": "String",
"type": "method"
},
{
"name": "getEncoding",
"text": "getEncoding()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getEncoding",
"leftLabel": "String",
"type": "method"
},
{
"name": "getParent",
"text": "getParent()",
"snippet": null,
"description": "Return the {Directory} that contains this file. ",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getParent",
"type": "method"
},
{
"name": "getPath",
"text": "getPath()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getPath",
"leftLabel": "String",
"type": "method"
},
{
"name": "getRealPath",
"text": "getRealPath()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getRealPath",
"leftLabel": "String",
"type": "method"
},
{
"name": "getRealPathSync",
"text": "getRealPathSync()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-getRealPathSync",
"leftLabel": "String",
"type": "method"
},
{
"name": "isDirectory",
"text": "isDirectory()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-isDirectory",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isFile",
"text": "isFile()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-isFile",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isSymbolicLink",
"text": "isSymbolicLink()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-isSymbolicLink",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "onDidChange",
"text": null,
"snippet": "onDidChange(${1:callback})",
"description": "Invoke the given callback when the file's contents change.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onDidChange",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDelete",
"text": null,
"snippet": "onDidDelete(${1:callback})",
"description": "Invoke the given callback when the file is deleted.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onDidDelete",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidRename",
"text": null,
"snippet": "onDidRename(${1:callback})",
"description": "Invoke the given callback when the file's path changes.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onDidRename",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onWillThrowWatchError",
"text": null,
"snippet": "onWillThrowWatchError(${1:callback})",
"description": "Invoke the given callback when there is an error with the watch.\nWhen your callback has been invoked, the file will have unsubscribed from\nthe file watches.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-onWillThrowWatchError",
"type": "method"
},
{
"name": "read",
"text": null,
"snippet": "read(${1:flushCache})",
"description": "Reads the contents of the file.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-read",
"leftLabel": null,
"type": "method"
},
{
"name": "setEncoding",
"text": null,
"snippet": "setEncoding(${1:encoding})",
"description": "Sets the file's character set encoding name.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-setEncoding",
"type": "method"
},
{
"name": "write",
"text": null,
"snippet": "write(${1:text})",
"description": "Overwrites the file with the given text.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-write",
"leftLabel": "Promise",
"type": "method"
},
{
"name": "writeSync",
"text": null,
"snippet": "writeSync(${1:text})",
"description": "Overwrites the file with the given text.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/File#instance-writeSync",
"leftLabel": null,
"type": "method"
}
],
"GitRepository": [
{
"name": "checkoutHead",
"text": null,
"snippet": "checkoutHead(${1:path})",
"description": "Restore the contents of a path in the working directory and index\nto the version at `HEAD`.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-checkoutHead",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "checkoutReference",
"text": null,
"snippet": "checkoutReference(${1:reference}, ${2:create})",
"description": "Checks out a branch in your repository.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-checkoutReference",
"leftLabel": null,
"type": "method"
},
{
"name": "destroy",
"text": "destroy()",
"snippet": null,
"description": "Destroy this {GitRepository} object.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-destroy",
"type": "method"
},
{
"name": "getAheadBehindCount",
"text": null,
"snippet": "getAheadBehindCount(${1:reference}, ${2:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getAheadBehindCount",
"leftLabel": null,
"type": "method"
},
{
"name": "getCachedPathStatus",
"text": null,
"snippet": "getCachedPathStatus(${1:path})",
"description": "Get the cached status for the given path.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getCachedPathStatus",
"leftLabel": "Number",
"type": "method"
},
{
"name": "getCachedUpstreamAheadBehindCount",
"text": null,
"snippet": "getCachedUpstreamAheadBehindCount(${1:path})",
"description": "Get the cached ahead/behind commit counts for the current branch's\nupstream branch.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getCachedUpstreamAheadBehindCount",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getConfigValue",
"text": null,
"snippet": "getConfigValue(${1:key}, ${2:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getConfigValue",
"leftLabel": null,
"type": "method"
},
{
"name": "getDiffStats",
"text": null,
"snippet": "getDiffStats(${1:path})",
"description": "Retrieves the number of lines added and removed to a path.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getDiffStats",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getDirectoryStatus",
"text": null,
"snippet": "getDirectoryStatus(${1:path})",
"description": "Get the status of a directory in the repository's working directory.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getDirectoryStatus",
"leftLabel": "Number",
"type": "method"
},
{
"name": "getLineDiffs",
"text": null,
"snippet": "getLineDiffs(${1:path}, ${2:text})",
"description": "Retrieves the line diffs comparing the `HEAD` version of the given\npath and the given text.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getLineDiffs",
"leftLabel": "Array",
"type": "method"
},
{
"name": "getOriginURL",
"text": null,
"snippet": "getOriginURL(${1:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getOriginURL",
"leftLabel": null,
"type": "method"
},
{
"name": "getPath",
"text": "getPath()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getPath",
"leftLabel": "String",
"type": "method"
},
{
"name": "getPathStatus",
"text": null,
"snippet": "getPathStatus(${1:path})",
"description": "Get the status of a single path in the repository.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getPathStatus",
"leftLabel": "Number",
"type": "method"
},
{
"name": "getReferenceTarget",
"text": null,
"snippet": "getReferenceTarget(${1:reference}, ${2:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getReferenceTarget",
"leftLabel": "String",
"type": "method"
},
{
"name": "getReferences",
"text": null,
"snippet": "getReferences(${1:path})",
"description": "Gets all the local and remote references.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getReferences",
"leftLabel": "Object",
"type": "method"
},
{
"name": "getShortHead",
"text": null,
"snippet": "getShortHead(${1:path})",
"description": "Retrieves a shortened version of the HEAD reference value.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getShortHead",
"leftLabel": "String",
"type": "method"
},
{
"name": "getType",
"text": "getType()",
"snippet": null,
"description": "A {String} indicating the type of version control system used by\nthis repository.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getType",
"leftLabel": null,
"type": "method"
},
{
"name": "getUpstreamBranch",
"text": null,
"snippet": "getUpstreamBranch(${1:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getUpstreamBranch",
"leftLabel": null,
"type": "method"
},
{
"name": "getWorkingDirectory",
"text": "getWorkingDirectory()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-getWorkingDirectory",
"leftLabel": "String",
"type": "method"
},
{
"name": "hasBranch",
"text": "hasBranch()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-hasBranch",
"leftLabel": null,
"type": "method"
},
{
"name": "isDestroyed",
"text": "isDestroyed()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isDestroyed",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isPathIgnored",
"text": null,
"snippet": "isPathIgnored(${1:path})",
"description": "Is the given path ignored?",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isPathIgnored",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "isPathModified",
"text": null,
"snippet": "isPathModified(${1:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isPathModified",
"leftLabel": null,
"type": "method"
},
{
"name": "isPathNew",
"text": null,
"snippet": "isPathNew(${1:path})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isPathNew",
"leftLabel": null,
"type": "method"
},
{
"name": "isProjectAtRoot",
"text": "isProjectAtRoot()",
"snippet": null,
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isProjectAtRoot",
"leftLabel": null,
"type": "method"
},
{
"name": "isStatusModified",
"text": null,
"snippet": "isStatusModified(${1:status})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isStatusModified",
"leftLabel": null,
"type": "method"
},
{
"name": "isStatusNew",
"text": null,
"snippet": "isStatusNew(${1:status})",
"description": "",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isStatusNew",
"leftLabel": null,
"type": "method"
},
{
"name": "isSubmodule",
"text": null,
"snippet": "isSubmodule(${1:path})",
"description": "Is the given path a submodule in the repository?",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-isSubmodule",
"leftLabel": "Boolean",
"type": "method"
},
{
"name": "onDidChangeStatus",
"text": null,
"snippet": "onDidChangeStatus(${1:callback})",
"description": "Invoke the given callback when a specific file's status has\nchanged. When a file is updated, reloaded, etc, and the status changes, this\nwill be fired.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-onDidChangeStatus",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidChangeStatuses",
"text": null,
"snippet": "onDidChangeStatuses(${1:callback})",
"description": "Invoke the given callback when a multiple files' statuses have\nchanged. For example, on window focus, the status of all the paths in the\nrepo is checked. If any of them have changed, this will be fired. Call\n{::getPathStatus(path)} to get the status for your path of choice.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-onDidChangeStatuses",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidDestroy",
"text": null,
"snippet": "onDidDestroy(${1:callback})",
"description": "Invoke the given callback when this GitRepository's destroy() method\nis invoked.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-onDidDestroy",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "relativize",
"text": "relativize()",
"snippet": null,
"description": "Makes a path relative to the repository's working directory.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GitRepository#instance-relativize",
"type": "method"
}
],
"Grammar": [
{
"name": "onDidUpdate",
"text": null,
"snippet": "onDidUpdate(${1:callback})",
"description": "Invoke the given callback when this grammar is updated due to a\ngrammar it depends on being added or removed from the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Grammar#instance-onDidUpdate",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "tokenizeLine",
"text": null,
"snippet": "tokenizeLine(${1:line}, ${2:ruleStack}, ${3:firstLine})",
"description": "Tokenize the line of text.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Grammar#instance-tokenizeLine",
"leftLabel": "Object",
"type": "method"
},
{
"name": "tokenizeLines",
"text": null,
"snippet": "tokenizeLines(${1:text})",
"description": "Tokenize all lines in the given text.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Grammar#instance-tokenizeLines",
"leftLabel": "Array",
"type": "method"
}
],
"GrammarRegistry": [
{
"name": "addGrammar",
"text": null,
"snippet": "addGrammar(${1:grammar})",
"description": "Add a grammar to this registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-addGrammar",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "getGrammars",
"text": "getGrammars()",
"snippet": null,
"description": "Get all the grammars in this registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-getGrammars",
"leftLabel": "Array",
"type": "method"
},
{
"name": "grammarForScopeName",
"text": null,
"snippet": "grammarForScopeName(${1:scopeName})",
"description": "Get a grammar with the given scope name.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-grammarForScopeName",
"leftLabel": "Grammar",
"type": "method"
},
{
"name": "loadGrammar",
"text": null,
"snippet": "loadGrammar(${1:grammarPath}, ${2:callback})",
"description": "Read a grammar asynchronously and add it to the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-loadGrammar",
"leftLabel": null,
"type": "method"
},
{
"name": "loadGrammarSync",
"text": null,
"snippet": "loadGrammarSync(${1:grammarPath})",
"description": "Read a grammar synchronously and add it to this registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-loadGrammarSync",
"leftLabel": "Grammar",
"type": "method"
},
{
"name": "onDidAddGrammar",
"text": null,
"snippet": "onDidAddGrammar(${1:callback})",
"description": "Invoke the given callback when a grammar is added to the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-onDidAddGrammar",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidRemoveGrammar",
"text": null,
"snippet": "onDidRemoveGrammar(${1:callback})",
"description": "Invoke the given callback when a grammar is removed from the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-onDidRemoveGrammar",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "onDidUpdateGrammar",
"text": null,
"snippet": "onDidUpdateGrammar(${1:callback})",
"description": "Invoke the given callback when a grammar is updated due to a grammar\nit depends on being added or removed from the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-onDidUpdateGrammar",
"leftLabel": "Disposable",
"type": "method"
},
{
"name": "readGrammar",
"text": null,
"snippet": "readGrammar(${1:grammarPath}, ${2:callback})",
"description": "Read a grammar asynchronously but don't add it to the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-readGrammar",
"leftLabel": null,
"type": "method"
},
{
"name": "readGrammarSync",
"text": null,
"snippet": "readGrammarSync(${1:grammarPath})",
"description": "Read a grammar synchronously but don't add it to the registry.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-readGrammarSync",
"leftLabel": "Grammar",
"type": "method"
},
{
"name": "removeGrammarForScopeName",
"text": null,
"snippet": "removeGrammarForScopeName(${1:scopeName})",
"description": "Remove the grammar with the given scope name.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/GrammarRegistry#instance-removeGrammarForScopeName",
"leftLabel": "Grammar",
"type": "method"
}
],
"Gutter": [
{
"name": "decorateMarker",
"text": null,
"snippet": "decorateMarker(${1:marker}, ${2:decorationParams})",
"description": "Add a decoration that tracks a {DisplayMarker}. When the marker moves,\nis invalidated, or is destroyed, the decoration will be updated to reflect\nthe marker's state.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-decorateMarker",
"leftLabel": "Decoration",
"type": "method"
},
{
"name": "destroy",
"text": "destroy()",
"snippet": null,
"description": "Destroys the gutter.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-destroy",
"type": "method"
},
{
"name": "hide",
"text": "hide()",
"snippet": null,
"description": "Hide the gutter.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-hide",
"type": "method"
},
{
"name": "isVisible",
"text": "isVisible()",
"snippet": null,
"description": "Determine whether the gutter is visible.",
"descriptionMoreURL": "https://atom.io/docs/api/latest/Gutter#instance-isVisible",