Index

Variables

Object literals

Variables

Let staticThemes

staticThemes: string[] = ["dark","default","greenmat","quake","shydactyl"]

Object literals

Let everything

everything: object

src/config.ts

src/config.ts: object

classes

classes: object

default_config

default_config: object

allowautofocus

allowautofocus: object

doc

doc: string[] = ["Controls whether the page can focus elements for you via js\n\nBest used in conjunction with browser.autofocus in `about:config`"]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

auconcreatecontainer

auconcreatecontainer: object

doc

doc: string[] = ["Autocontain directives create a container if it doesn't exist already."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

autocmds

autocmds: object

doc

doc: string[] = ["Autocommands that run when certain events happen, and other conditions are met.\n\nRelated ex command: `autocmd`."]

type

type: object

kind

kind: string = "object"

autocontain

autocontain: object

doc

doc: string[] = ["Automatically place these sites in the named container.\n\nEach key corresponds to a URL fragment which, if contained within the page URL, the site will be opened in a container tab instead."]

type

type: object

kind

kind: string = "any"

browser

browser: object

doc

doc: string[] = ["The browser executable to look for in commands such as `restart`. Not as mad as it seems if you have multiple versions of Firefox..."]

type

type: object

kind

kind: string = "string"

configversion

configversion: object

doc

doc: string[] = ["Internal version number Tridactyl uses to know whether it needs to update from old versions of the configuration.\n\nChanging this might do weird stuff."]

type

type: object

kind

kind: string = "string"

containerindicator

containerindicator: object

doc

doc: string[] = ["If moodeindicator is enabled, containerindicator will color the border of the mode indicator with the container color."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

csp

csp: object

doc

doc: string[] = ["Change this to \"clobber\" to ruin the \"Content Security Policy\" of all sites a bit and make Tridactyl run a bit better on some of them, e.g. raw.github*"]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "untouched"},{"kind": "LiteralType","name": "clobber"}]

kind

kind: string = "union"

cursorpos

cursorpos: object

doc

doc: string[] = ["Decides where to place the cursor when selecting non-empty input fields"]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "beginning"},{"kind": "LiteralType","name": "end"}]

kind

kind: string = "union"

editorcmd

editorcmd: object

doc

doc: string[] = ["Insert / input mode edit-in-$EDITOR command to run\nThis has to be a command that stays in the foreground for the whole editing session\n\"auto\" will attempt to find a sane editor in your path.\nPlease send your requests to have your favourite terminal moved further up the list to /dev/null.\n (but we are probably happy to add your terminal to the list if it isn't already there.)"]

type

type: object

kind

kind: string = "string"

exaliases

exaliases: object

doc

doc: string[] = ["Aliases for the commandline.\n\nYou can make a new one with `command alias ex-command`."]

type

type: object

kind

kind: string = "object"

externalclipboardcmd

externalclipboardcmd: object

doc

doc: string[] = ["Clipboard command to try to get the selection from (e.g. `xsel` or `xclip`)"]

type

type: object

kind

kind: string = "string"

followpagepatterns

followpagepatterns: object

doc

doc: string[] = ["Used by `]]` and `[[` to look for links containing these words.\n\nEdit these if you want to add, e.g. other language support."]

type

type: object

kind

kind: string = "object"

gimode

gimode: object

doc

doc: string[] = ["If nextinput, <Tab> after gi brings selects the next input\n\nIf firefox, <Tab> selects the next selectable element, e.g. a link"]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "nextinput"},{"kind": "LiteralType","name": "firefox"}]

kind

kind: string = "union"

hintchars

hintchars: object

doc

doc: string[] = ["Characters to use in hint mode.\n\nThey are used preferentially from left to right."]

type

type: object

kind

kind: string = "string"

hintdelay

hintdelay: object

doc

doc: string[] = ["The delay in milliseconds in `vimperator` style hint modes after selecting a hint before you are returned to normal mode.\n\nThe point of this is to prevent accidental execution of normal mode binds due to people typing more than is necessary to choose a hint."]

type

type: object

kind

kind: string = "string"

hintfiltermode

hintfiltermode: object

doc

doc: string[] = ["The type of hinting to use. `vimperator` will allow you to filter links based on their names by typing non-hint chars. It is recommended that you use this in conjuction with the [[hintchars]] setting, which you should probably set to e.g, `5432167890`."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "simple"},{"kind": "LiteralType","name": "vimperator"},{"kind": "LiteralType","name": "vimperator-reflow"}]

kind

kind: string = "union"

hintnames

hintnames: object

doc

doc: string[] = ["Whether to optimise for the shortest possible names for each hint, or to use a simple numerical ordering. If set to `numeric`, overrides `hintchars` setting."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "short"},{"kind": "LiteralType","name": "numeric"}]

kind

kind: string = "union"

hintuppercase

hintuppercase: object

doc

doc: string[] = ["Whether to display the names for hints in uppercase."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

historyresults

historyresults: object

doc

doc: string[] = ["Number of most recent results to ask Firefox for. We display the top 20 or so most frequently visited ones."]

type

type: object

kind

kind: string = "string"

homepages

homepages: object

doc

doc: string[] = ["Pages opened with `gH`."]

type

type: object

kind

kind: string = "array"

type

type: object

kind

kind: string = "any"

ignoremaps

ignoremaps: object

doc

doc: string[] = ["ignoremaps contain all of the bindings for \"ignore mode\".\n\nThey consist of key sequences mapped to ex commands."]

type

type: object

kind

kind: string = "object"

imaps

imaps: object

doc

doc: string[] = ["imaps contain all of the bindings for \"insert mode\".\n\nThey consist of key sequences mapped to ex commands."]

type

type: object

kind

kind: string = "object"

inputmaps

inputmaps: object

doc

doc: string[] = ["inputmaps contain all of the bindings for \"input mode\".\n\nThey consist of key sequences mapped to ex commands."]

type

type: object

kind

kind: string = "object"

jumpdelay

jumpdelay: object

doc

doc: string[] = ["Milliseconds before registering a scroll in the jumplist"]

type

type: object

kind

kind: string = "string"

logging

logging: object

doc

doc: string[] = ["Default logging levels - 2 === WARNING\n\nNB: these cannot be set directly with `set` - you must use magic words such as `WARNING` or `DEBUG`."]

type

type: object

kind

kind: string = "object"

modeindicator

modeindicator: object

doc

doc: string[] = ["Whether to display the mode indicator or not."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

nativeinstallcmd

nativeinstallcmd: object

doc

doc: string[] = ["Set this to something weird if you want to have fun every time Tridactyl tries to update its native messenger."]

type

type: object

kind

kind: string = "string"

newtab

newtab: object

doc

doc: string[] = ["URL the newtab will redirect to.\n\nAll usual rules about things you can open with `open` apply, with the caveat that you'll get interesting results if you try to use something that needs `nativeopen`: so don't try `about:newtab`."]

type

type: object

kind

kind: string = "string"

nmaps

nmaps: object

doc

doc: string[] = ["nmaps contain all of the bindings for \"normal mode\".\n\nThey consist of key sequences mapped to ex commands."]

type

type: object

kind

kind: string = "object"

noiframeon

noiframeon: object

doc

doc: undefined[] = []

type

type: object

kind

kind: string = "array"

type

type: object

kind

kind: string = "string"

profiledir

profiledir: object

doc

doc: string[] = ["Profile directory to use with native messenger with e.g, `guiset`."]

type

type: object

kind

kind: string = "string"

putfrom

putfrom: object

doc

doc: string[] = ["Which clipboard to retrieve items from. Requires the native messenger to be installed.\n\nPermitted values: `clipboard`, or `selection`."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "clipboard"},{"kind": "LiteralType","name": "selection"}]

kind

kind: string = "union"

relatedopenpos

relatedopenpos: object

doc

doc: string[] = ["Where to open tabs opened with hinting - as if it had been middle clicked, to the right of the current tab, or at the end of the tabs."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "next"},{"kind": "LiteralType","name": "last"},{"kind": "LiteralType","name": "related"}]

kind

kind: string = "union"

scrollduration

scrollduration: object

doc

doc: string[] = ["How viscous you want smooth scrolling to feel."]

type

type: object

kind

kind: string = "string"

searchengine

searchengine: object

doc

doc: string[] = ["The default search engine used by `open search`"]

type

type: object

kind

kind: string = "string"

searchurls

searchurls: object

doc

doc: string[] = ["Definitions of search engines for use via `open [keyword]`."]

type

type: object

kind

kind: string = "object"

smoothscroll

smoothscroll: object

doc

doc: string[] = ["Whether to use Tridactyl's (bad) smooth scrolling."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

storageloc

storageloc: object

doc

doc: string[] = ["Which storage to use. Sync storage will synchronise your settings via your Firefox Account."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "sync"},{"kind": "LiteralType","name": "local"}]

kind

kind: string = "union"

tabopencontaineraware

tabopencontaineraware: object

doc

doc: string[] = ["If enabled, tabopen opens a new tab in the currently active tab's container."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}]

kind

kind: string = "union"

tabopenpos

tabopenpos: object

doc

doc: string[] = ["Where to open tabs opened with `tabopen` - to the right of the current tab, or at the end of the tabs."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "next"},{"kind": "LiteralType","name": "last"}]

kind

kind: string = "union"

theme

theme: object

doc

doc: string[] = ["The theme to use.\n\nPermitted values: run `:composite js tri.styling.THEMES | fillcmdline` to find out."]

type

type: object

kind

kind: string = "string"

ttspitch

ttspitch: object

doc

doc: string[] = ["Controls text-to-speech pitch. Has to be between 0 and 2."]

type

type: object

kind

kind: string = "string"

ttsrate

ttsrate: object

doc

doc: string[] = ["Controls text-to-speech speed. Has to be a number between 0.1 and 10."]

type

type: object

kind

kind: string = "string"

ttsvoice

ttsvoice: object

doc

doc: string[] = ["The name of the voice to use for text-to-speech. You can get the list of installed voices by running the following snippet: `js alert(window.speechSynthesis.getVoices().reduce((a, b) => a + \" \" + b.name))`"]

type

type: object

kind

kind: string = "string"

ttsvolume

ttsvolume: object

doc

doc: string[] = ["Controls text-to-speech volume. Has to be a number between 0 and 1."]

type

type: object

kind

kind: string = "string"

viewsource

viewsource: object

doc

doc: string[] = ["Whether `:viewsource` will use our own page that you can use Tridactyl binds on, or Firefox's default viewer, which you cannot use Tridactyl on."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "tridactyl"},{"kind": "LiteralType","name": "default"}]

kind

kind: string = "union"

win_nativeinstallcmd

win_nativeinstallcmd: object

doc

doc: string[] = ["Set this to something weird if you want to have fun every time Tridactyl tries to update its native messenger."]

type

type: object

kind

kind: string = "string"

yankto

yankto: object

doc

doc: string[] = ["Which clipboard to store items in. Requires the native messenger to be installed."]

type

type: object

arguments

arguments: object[] = [{"kind": "LiteralType","name": "clipboard"},{"kind": "LiteralType","name": "selection"},{"kind": "LiteralType","name": "both"}]

kind

kind: string = "union"

functions

functions: object

get

get: object

doc

doc: string[] = ["Get the value of the key target.\n\nIf the user has not specified a key, use the corresponding key from\ndefaults, if one exists, else undefined."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "any"},"name": "target"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "any"

getAsync

getAsync: object

doc

doc: string[] = ["Get the value of the key target, but wait for config to be loaded from the\ndatabase first if it has not been at least once before.\n\nThis is useful if you are a content script and you've just been loaded."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "any"},"name": "target"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

getDeepProperty

getDeepProperty: object

doc

doc: string[] = ["Given an object and a target, extract the target if it exists, else return undefined"]

type

type: object

arguments

arguments: object[] = [{"kind": "any","name": "obj"},{"kind": "any","name": "target"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "any"

init

init: object

doc

doc: string[] = ["Read all user configuration from storage API then notify any waiting asynchronous calls\n\nasynchronous calls generated by getAsync."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

o

o: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "any","name": "object"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "any"

save

save: object

doc

doc: string[] = ["Save the config back to storage API.\n\nConfig is not synchronised between different instances of this module until\nsometime after this happens."]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "sync"},{"kind": "LiteralType","name": "local"}],"name": "storage"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

schlepp

schlepp: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "any","name": "settings"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

set

set: object

doc

doc: string[] = ["Full target specification, then value\n\ne.g.\n set(\"nmaps\", \"o\", \"open\")\n set(\"search\", \"default\", \"google\")\n set(\"aucmd\", \"BufRead\", \"memrise.com\", \"open memrise.com\")"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "any"},"name": "args"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

setDeepProperty

setDeepProperty: object

doc

doc: string[] = ["Create the key path target if it doesn't exist and set the final property to value.\n\nIf the path is an empty array, replace the obj."]

type

type: object

arguments

arguments: object[] = [{"kind": "any","name": "obj"},{"kind": "any","name": "value"},{"kind": "any","name": "target"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "any"

unset

unset: object

doc

doc: string[] = ["Delete the key at target if it exists"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "any"},"name": "target"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

update

update: object

doc

doc: string[] = ["Updates the config to the latest version.\nProposed semantic for config versionning:\n- x.y -> x+1.0 : major architectural changes\n- x.y -> x.y+1 : renaming settings/changing their types\nThere's no need for an updater if you're only adding a new setting/changing\na default setting\n\nWhen adding updaters, don't forget to set(\"configversion\", newversionnumber)!"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

src/excmds.ts

src/excmds.ts: object

functions

functions: object

addJump

addJump: object

doc

doc: string[] = ["Called on 'scroll' events.\nIf you want to have a function that moves within the page but doesn't add a\nlocation to the jumplist, make sure to set JUMPED to true before moving\naround.\nThe setTimeout call is required because sometimes a user wants to move\nsomewhere by pressing 'j' multiple times and we don't want to add the\nin-between locations to the jump list"]

type

type: object

arguments

arguments: object[] = [{"kind": "UIEvent","name": "scrollEvent"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

autocmd

autocmd: object

doc

doc: string[] = ["Set autocmds to run when certain events happen."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "event"},{"kind": "string","name": "url"},{"kind": "array","type": {"kind": "string"},"name": "excmd"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

autocmddelete

autocmddelete: object

doc

doc: string[] = ["Remove autocmds"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "event"},{"kind": "string","name": "url"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

autocontain

autocontain: object

doc

doc: string[] = ["Automatically open a domain and all its subdomains in a specified container.\n\nFor declaring containers that do not yet exist, consider using `auconscreatecontainer true` in your tridactylrc.\nThis allows tridactyl to automatically create containers from your autocontain directives. Note that they will be random icons and colors.\n\n** NB: This is an experimental feature, if you encounter issues please create an issue on github. **\n\nThe domain is passed through as a regular expression so there are a few gotchas to be aware of:\n* Unescaped periods will match *anything*. `autocontain google.co.uk work` will match `google!co$uk`. Escape your periods or accept that you might get some false positives.\n* You can use regex in your domain pattern. `autocontain google\\,(co\\.uk|com) work` will match either `google.co.uk` or `google.com`."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "domain"},{"kind": "string","name": "container"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

back

back: object

doc

doc: string[] = ["Navigate back one page in history. "]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

bind

bind: object

doc

doc: string[] = ["Bind a sequence of keys to an excmd or view bound sequence.\n\nThis is an easier-to-implement bodge while we work on vim-style maps.\n\nExamples:\n\n - `bind G fillcmdline tabopen google`\n - `bind D composite tabclose | buffer #`\n - `bind j scrollline 20`\n - `bind F hint -b`\n\nYou can view binds by omitting the command line:\n\n - `bind j`\n - `bind k`\n\nYou can bind to modifiers and special keys by enclosing them with angle brackets, for example `bind <C-\\>z fullscreen`, `unbind <F1>` (a favourite of people who use TreeStyleTabs :) ), or `bind <Backspace> forward`.\n\nModifiers are truncated to a single character, so Ctrl -> C, Alt -> A, and Shift -> S. Shift is a bit special as it is only required if Shift does not change the key inputted, e.g. `<S-ArrowDown>` is OK, but `<S-a>` should just be `A`.\n\nYou can view all special key names here: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values\n\nUse [[composite]] if you want to execute multiple excmds. Use\n[[fillcmdline]] to put a string in the cmdline and focus the cmdline\n(otherwise the string is executed immediately).\n\n\nYou can bind to other modes with `bind --mode={insert|ignore|normal|input} ...`, e.g, `bind --mode=insert emacs qall` (NB: unlike vim, all preceeding characters will not be input).\n\nSee also:\n\n - [[unbind]]\n - [[reset]]"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

blacklistadd

blacklistadd: object

doc

doc: string[] = ["Helper function to put Tridactyl into ignore mode on the provided URL.\n\nSimply creates a DocStart [[autocmd]] that runs `mode ignore`.\n\nDue to a Tridactyl bug, the only way to remove these rules once they are set is to delete all of your autocmds with `unset autocmds`.\n\n<!-- this should probably be moved to an ex alias once configuration has better help --!>"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "url"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

bmark

bmark: object

doc

doc: string[] = ["Add or remove a bookmark.\n\nOptionally, you may give the bookmark a title. If no URL is given, a bookmark is added for the current page.\n\nIf a bookmark already exists for the URL, it is removed, even if a title is given.\n\nDoes not support creation of folders: you'll need to use the Firefox menus for that."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "url"},{"kind": "array","type": {"kind": "string"},"name": "titlearr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

buffer

buffer: object

doc

doc: string[] = ["Change active tab."]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "number"},{"kind": "LiteralType","name": "#"}],"name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

bufferall

bufferall: object

doc

doc: string[] = ["Change active tab."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "id"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

changelistjump

changelistjump: object

doc

doc: string[] = ["Focus the tab which contains the last focussed input element. If you're lucky, it will focus the right input, too.\n\nCurrently just goes to the last focussed input; being able to jump forwards and backwards is planned."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

clipboard

clipboard: object

doc

doc: string[] = ["Use the system clipboard.\n\nIf `excmd == \"open\"`, call [[open]] with the contents of the clipboard. Similarly for [[tabopen]].\n\nIf `excmd == \"yank\"`, copy the current URL, or if given, the value of toYank, into the system clipboard.\n\nIf `excmd == \"yankcanon\"`, copy the canonical URL of the current page if it exists, otherwise copy the current URL.\n\nIf `excmd == \"yankshort\"`, copy the shortlink version of the current URL, and fall back to the canonical then actual URL. Known to work on https://yankshort.neocities.org/.\n\nIf `excmd == \"yanktitle\"`, copy the title of the open page.\n\nIf `excmd == \"yankmd\"`, copy the title and url of the open page formatted in Markdown for easy use on sites such as reddit.\n\nIf you're on Linux and the native messenger is installed, Tridactyl will call an external binary (either xclip or xsel) to read or write to your X selection buffer. If you want another program to be used, set \"externalclipboardcmd\" to its name and make sure it has the same interface as xsel/xclip (\"-i\"/\"-o\" and reading from stdin).\n\nWhen doing a read operation (i.e. open or tabopen), if \"putfrom\" is set to \"selection\", the X selection buffer will be read instead of the clipboard. Set \"putfrom\" to \"clipboard\" to use the clipboard.\n\nWhen doing a write operation, if \"yankto\" is set to \"selection\", only the X selection buffer will be written to. If \"yankto\" is set to \"both\", both the X selection and the clipboard will be written to. If \"yankto\" is set to \"clipboard\", only the clipboard will be written to."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "open"},{"kind": "LiteralType","name": "tabopen"},{"kind": "LiteralType","name": "yank"},{"kind": "LiteralType","name": "yankshort"},{"kind": "LiteralType","name": "yankcanon"},{"kind": "LiteralType","name": "yanktitle"},{"kind": "LiteralType","name": "yankmd"}],"name": "excmd"},{"kind": "array","type": {"kind": "string"},"name": "toYank"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

comclear

comclear: object

doc

doc: string[] = ["Similar to vim's `comclear` command. Clears an excmd alias defined by\n`command`.\n\nFor example: `comclear helloworld` will reverse any changes caused\nby `command helloworld xxx`\n\nSee also:\n - [[command]]"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "name"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

command

command: object

doc

doc: string[] = ["Similar to vim's `:command`. Maps one ex-mode command to another.\nIf command already exists, this will override it, and any new commands\nadded in a future release will be SILENTLY overridden. Aliases are\nexpanded recursively.\n\nExamples:\n - `command t tabopen`\n - `command tn tabnext_gt`\n = `command hello t` This will expand recursively into 'hello'->'tabopen'\n\nNote that this is only for excmd->excmd mappings. To map a normal-mode\ncommand to an excommand, see [[bind]].\n\nSee also:\n - [[comclear]]"]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "name"},{"kind": "array","type": {"kind": "string"},"name": "definition"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

composite

composite: object

doc

doc: string[] = ["Split `cmds` on pipes (|) and treat each as its own command. Return values are passed as the last argument of the next ex command, e.g,\n\n`composite echo yes | fillcmdline` becomes `fillcmdline yes`. A more complicated example is the ex alias, `command current_url composite get_current_url | fillcmdline_notrail `, which is used in, e.g. `bind T current_url tabopen`.\n\nWorkaround: this should clearly be in the parser, but we haven't come up with a good way to deal with |s in URLs, search terms, etc. yet.\n\n`cmds` are also split with semicolons (;) and don't pass things along to each other.\n\nThe behaviour of combining ; and | in the same composite command is left as an exercise for the reader."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "cmds"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

containerclose

containerclose: object

doc

doc: string[] = ["Closes all tabs open in the same container across all windows."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "name"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

containercreate

containercreate: object

doc

doc: string[] = ["Creates a new container. Note that container names must be unique and that the checks are case-insensitive.\n\nFurther reading https://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/contextualIdentities/ContextualIdentity\n\nExample usage:\n - `:containercreate tridactyl green dollar`"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "name"},{"kind": "string","name": "color"},{"kind": "string","name": "icon"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

containerdelete

containerdelete: object

doc

doc: string[] = ["Delete a container. Closes all tabs associated with that container beforehand. Note: container names are case-insensitive."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "name"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

containerupdate

containerupdate: object

doc

doc: string[] = ["Update a container's information. Note that none of the parameters are optional and that container names are case-insensitive.\n\nExample usage:\n\n- Changing the container name: `:containerupdate banking blockchain green dollar`\n\n- Changing the container icon: `:containerupdate banking banking green briefcase`\n\n- Changing the container color: `:containerupdate banking banking purple dollar`"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "name"},{"kind": "string","name": "uname"},{"kind": "string","name": "ucolor"},{"kind": "string","name": "uicon"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

credits

credits: object

doc

doc: string[] = ["Display Tridactyl's contributors in order of commits in a user-friendly fashion"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "excmd"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

cssparse

cssparse: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "css"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

curJumps

curJumps: object

doc

doc: string[] = ["Returns a promise for an object containing the jumplist of all pages accessed in the current tab.\nThe keys of the object currently are the page's URL, however this might change some day. Use [[getJumpPageId]] to access the jumplist of a specific page."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

echo

echo: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "str"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "string"}]

kind

kind: string = "Promise"

editor

editor: object

doc

doc: string[] = ["Opens your favourite editor (which is currently gVim) and fills the last used input with whatever you write into that file.\n**Requires that the native messenger is installed, see [[native]] and [[installnative]]**.\n\nUses the `editorcmd` config option, default = `auto` looks through a list defined in native_background.ts try find a sensible combination. If it's a bit slow, or chooses the wrong editor, or gives up completely, set editorcmd to something you want. The command must stay in the foreground until the editor exits.\n\nThe editorcmd needs to accept a filename, stay in the foreground while it's edited, save the file and exit.\n\nYou're probably better off using the default insert mode bind of `<C-i>` (Ctrl-i) to access this."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

exclaim

exclaim: object

doc

doc: string[] = ["Run command in /bin/sh (unless you're on Windows), and print the output in the command line. Non-zero exit codes and stderr are ignored, currently.\n\nRequires the native messenger, obviously.\n\nIf you want to use a different shell, just prepend your command with whatever the invocation is and keep in mind that most shells require quotes around the command to be executed, e.g. `:exclaim xonsh -c \"1+2\"`.\n\nAliased to `!` but the exclamation mark **must be followed with a space**."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "str"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

exclaim_quiet

exclaim_quiet: object

doc

doc: string[] = ["Like exclaim, but without any output to the command line."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "str"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "string"}]

kind

kind: string = "Promise"

fillcmdline

fillcmdline: object

doc

doc: string[] = ["Set the current value of the commandline to string *with* a trailing space "]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "strarr"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

fillcmdline_nofocus

fillcmdline_nofocus: object

doc

doc: string[] = ["Show and fill the command line without focusing it "]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "strarr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

fillcmdline_notrail

fillcmdline_notrail: object

doc

doc: string[] = ["Set the current value of the commandline to string *without* a trailing space "]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "strarr"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

fillcmdline_tmp

fillcmdline_tmp: object

doc

doc: string[] = ["Shows str in the command line for ms milliseconds. Recommended duration: 3000ms. "]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "number","name": "ms"},{"kind": "array","type": {"kind": "string"},"name": "strarr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

fillinput

fillinput: object

doc

doc: string[] = ["Fills the element matched by `selector` with content and falls back to the last used input if the element can't be found. You probably don't want this; it's used internally for [[editor]].\n\nThat said, `bind gs fillinput null [Tridactyl](https://addons.mozilla.org/en-US/firefox/addon/tridactyl-vim/) is my favourite add-on` could probably come in handy."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "selector"},{"kind": "array","type": {"kind": "string"},"name": "content"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

find

find: object

doc

doc: string[] = ["Start find mode. Work in progress."]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "1"},{"kind": "LiteralType","name": "-1"}],"name": "direction"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

findRelLink

findRelLink: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "RegExp","name": "pattern"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "HTMLAnchorElement"

findnext

findnext: object

doc

doc: string[] = ["Highlight the next occurence of the previously searched for word."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

fixamo

fixamo: object

doc

doc: string[] = ["Simply sets\n```js\n * \"privacy.resistFingerprinting.block_mozAddonManager\":true\n * \"extensions.webextensions.restrictedDomains\":\"\"\n * ```\nin about:config via user.js so that Tridactyl (and other extensions!) can be used on addons.mozilla.org and other sites.\n\nRequires `native` and a `restart`."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

fixamo_quiet

fixamo_quiet: object

doc

doc: string[] = ["Like [[fixamo]] but quieter."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

focusbyid

focusbyid: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "id"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

focusinput

focusinput: object

doc

doc: string[] = ["Focus the last used input on the page"]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "string"},{"kind": "number"}],"name": "nth"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

followpage

followpage: object

doc

doc: string[] = ["Find a likely next/previous link and follow it\n\nIf a link or anchor element with rel=rel exists, use that, otherwise fall back to:\n\n 1) find the last anchor on the page with innerText matching the appropriate `followpagepattern`.\n 2) call [[urlincrement]] with 1 or -1\n\nIf you want to support e.g. French:\n\n```\n set followpagepatterns.next ^(next|newer|prochain)\\b|»|>>\n set followpagepatterns.prev ^(prev(ious)?|older|précédent)\\b|»|>>\n ```"]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "next"},{"kind": "LiteralType","name": "prev"}],"name": "rel"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

forceURI

forceURI: object

doc

doc: string[] = ["Take a string and find a way to interpret it as a URI or search query. "]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "maybeURI"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "string"

forward

forward: object

doc

doc: string[] = ["Navigate forward one page in history. "]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

fullscreen

fullscreen: object

doc

doc: string[] = ["Toggle fullscreen state"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

get

get: object

doc

doc: string[] = ["Puts the contents of config value with keys `keys` into the commandline and the background page console\n\nIt's a bit rubbish, but we don't have a good way to provide feedback to the commandline yet.\n\nYou can view the log entry in the browser console (Ctrl-Shift-j).\n\nFor example, you might try `get nmaps` to see all of your current binds."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "keys"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

getInputSelector

getInputSelector: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

getJumpPageId

getJumpPageId: object

doc

doc: string[] = ["This is used as an ID for the current page in the jumplist.\nIt has a potentially confusing behavior: if you visit site A, then site B, then visit site A again, the jumplist that was created for your first visit on A will be re-used for your second visit.\nAn ideal solution would be to have a counter that is incremented every time a new page is visited within the tab and use that as the return value for getJumpPageId but this doesn't seem to be trivial to implement."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

kind

kind: string = "string"

getNativeVersion

getNativeVersion: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

getSortedWinTabs

getSortedWinTabs: object

doc

doc: string[] = ["Get list of tabs sorted by most recent use"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "any"}}]

kind

kind: string = "Promise"

get_current_url

get_current_url: object

doc

doc: string[] = ["Returns the current URL. For use with [[composite]]."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

getclip

getclip: object

doc

doc: string[] = ["Fetches the content of the clipboard/selection buffer depending on user's preferences"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

getinput

getinput: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "string"}]

kind

kind: string = "Promise"

getnexttabs

getnexttabs: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "tabid"},{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "any"}}]

kind

kind: string = "Promise"

geturlsforlinks

geturlsforlinks: object

doc

doc: string[] = ["Returns the url of links that have a matching rel.\n\nDon't bind to this: it's an internal function."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "reltype"},{"kind": "string","name": "rel"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "any"

gobble

gobble: object

doc

doc: string[] = ["Initialize gobble mode.\n\nIt will read `nChars` input keys, append them to `endCmd` and execute that\nstring."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "nChars"},{"kind": "string","name": "endCmd"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

guiset

guiset: object

doc

doc: string[] = ["Change which parts of the Firefox user interface are shown. **NB: This feature is experimental and might break stuff.**\n\nMight mangle your userChrome. Requires native messenger, and you must restart Firefox each time to see any changes (this can be done using [[restart]]). <!-- (unless you enable addon debugging and refresh using the browser toolbox) -->\n\nView available rules and options [here](/static/docs/modules/_src_css_util_.html#potentialrules) and [here](/static/docs/modules/_src_css_util_.html#metarules).\n\nExample usage: `guiset gui none`, `guiset gui full`, `guiset tabs autohide`.\n\nSome of the available options:\n\n- gui\n - full\n - none\n\n- tabs\n - always\n - autohide\n\n- navbar\n - always\n - autohide\n - none\n\n- hoverlink (the little link that appears when you hover over a link)\n - none\n - left\n - right\n - top-left\n - top-right\n\n- titlebar\n - hide\n - show\n\nIf you want to use guiset in your tridactylrc, you might want to use [[guiset_quiet]] instead."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "rule"},{"kind": "string","name": "option"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

guiset_quiet

guiset_quiet: object

doc

doc: string[] = ["Like [[guiset]] but quieter."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "rule"},{"kind": "string","name": "option"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "MessageResp"}]

kind

kind: string = "Promise"

hasScheme

hasScheme: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "uri"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "RegExpMatchArray"

help

help: object

doc

doc: string[] = ["Show this page.\n\n`:help something` jumps to the entry for something. Something can be an excmd, an alias for an excmd or a binding.\n\nThe \"nmaps\" list is a list of all the bindings for the command you're seeing and the \"exaliases\" list lists all its aliases.\n\nIf there's a conflict (e.g. you have a \"go\" binding that does something and also a \"go\" excmd that does something else), the binding has higher priority.\n\nIf the keyword you gave to `:help` is actually an alias for a composite command (see [[composite]]) , you will be taken to the help section for the first command of the pipeline. You will be able to see the whole pipeline by hovering your mouse over the alias in the \"exaliases\" list. Unfortunately there currently is no way to display these HTML tooltips from the keyboard.\n\ne.g. `:help bind`"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "excmd"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

hidecmdline

hidecmdline: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

hint

hint: object

doc

doc: string[] = ["Hint a page."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "option"},{"kind": "string","name": "selectors"},{"kind": "array","type": {"kind": "string"},"name": "rest"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

history

history: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

home

home: object

doc

doc: string[] = ["Go to the homepages you have set with `set home [url1] [url2]`.\n\n "]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "true"},{"kind": "LiteralType","name": "false"}],"name": "all"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

idFromIndex

idFromIndex: object

doc

doc: string[] = ["Resolve a tab index to the tab id of the corresponding tab in this window."]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "string"},{"kind": "number"}],"name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "number"}]

kind

kind: string = "Promise"

installnative

installnative: object

doc

doc: string[] = ["Simply copies \"curl -fsSl https://raw.githubusercontent.com/cmcaine/tridactyl/master/native/install.sh | bash\" to the clipboard and tells the user to run it."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

js

js: object

doc

doc: string[] = ["Lets you execute JavaScript in the page context. If you want to get the result back, use `composite js ... | fillcmdline`\n\nSome of Tridactyl's functions are accessible here via the `tri` object. Just do `console.log(tri)` in the web console on the new tab page to see what's available.\n\nIf you want to pipe an argument to `js`, you need to use the \"-p\" flag and then use the JS_ARG global variable, e.g:\n\n`composite get_current_url | js -p alert(JS_ARG)`"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "str"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

jsb

jsb: object

doc

doc: string[] = ["Lets you execute JavaScript in the background context. All the help from [[js]] applies. Gives you a different `tri` object."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "str"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

jumpnext

jumpnext: object

doc

doc: string[] = ["Calls [[jumpprev]](-n) "]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

jumpprev

jumpprev: object

doc

doc: string[] = ["Similar to Pentadactyl or vim's jump list."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

loadaucmds

loadaucmds: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "DocStart"},{"kind": "LiteralType","name": "DocLoad"},{"kind": "LiteralType","name": "DocEnd"},{"kind": "LiteralType","name": "TabEnter"},{"kind": "LiteralType","name": "TabLeft"}],"name": "cmdType"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

loggingsetlevel

loggingsetlevel: object

doc

doc: string[] = ["Set the logging level for a given logging module."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "logModule"},{"kind": "string","name": "level"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

mode

mode: object

doc

doc: string[] = ["Example:\n - `mode ignore` to ignore all keys."]

type

type: object

arguments

arguments: object[] = [{"kind": "ModeName","name": "mode"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

mute

mute: object

doc

doc: string[] = ["Mute current tab or all tabs.\n\nPassing \"all\" to the excmd will operate on the mute state of all tabs.\nPassing \"unmute\" to the excmd will unmute.\nPassing \"toggle\" to the excmd will toggle the state of `browser.tabs.tab.MutedInfo`"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "muteArgs"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

native

native: object

doc

doc: string[] = ["Tells you if the native messenger is installed and its version."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

nativeopen

nativeopen: object

doc

doc: string[] = ["Uses the native messenger to open URLs.\n\n**Be *seriously* careful with this: you can use it to open any URL you can open in the Firefox address bar.**\n\nYou've been warned."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "url"},{"kind": "array","type": {"kind": "string"},"name": "firefoxArgs"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

open

open: object

doc

doc: string[] = ["Open a new page in the current tab."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "urlarr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

open_quiet

open_quiet: object

doc

doc: string[] = ["Like [[open]] but doesn't make a new entry in history."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "urlarr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

parse_bind_args

parse_bind_args: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "bind_args"

pin

pin: object

doc

doc: string[] = ["Pin the current tab "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

qall

qall: object

doc

doc: string[] = ["Close all windows "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

quickmark

quickmark: object

doc

doc: string[] = ["Bind a quickmark for the current URL or space-separated list of URLs to a key on the keyboard.\n\nAfterwards use go[key], gn[key], or gw[key] to [[open]], [[tabopen]], or\n[[winopen]] the URL respectively."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "key"},{"kind": "array","type": {"kind": "string"},"name": "addressarr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

reader

reader: object

doc

doc: string[] = ["Opens the current page in Firefox's reader mode.\nYou currently cannot use Tridactyl while in reader mode."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

reload

reload: object

doc

doc: string[] = ["Reload the next n tabs, starting with activeTab, possibly bypassingCache "]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"},{"kind": "boolean","name": "hard"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

reloadall

reloadall: object

doc

doc: string[] = ["Reloads all tabs, bypassing the cache if hard is set to true "]

type

type: object

arguments

arguments: object[] = [{"kind": "boolean","name": "hard"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

reloadhard

reloadhard: object

doc

doc: string[] = ["Reload the next n tabs, starting with activeTab. bypass cache for all "]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

removeSource

removeSource: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

repeat

repeat: object

doc

doc: string[] = ["Repeats a `cmd` `n` times.\nFalls back to the last executed command if `cmd` doesn't exist.\nExecutes the command once if `n` isn't defined either."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "number","name": "n"},{"kind": "array","type": {"kind": "string"},"name": "exstr"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

reset

reset: object

doc

doc: string[] = ["Restores a sequence of keys to their default value.\n\nSee also:\n\n - [[bind]]\n - [[unbind]]"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "key"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

restart

restart: object

doc

doc: string[] = ["Restarts firefox with the same commandline arguments.\n\nWarning: This can kill your tabs, especially if you :restart several times\nin a row"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

run_exstr

run_exstr: object

doc

doc: string[] = ["Hacky ex string parser.\n\nUse it for fire-and-forget running of background commands in content."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "commands"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

sanitise

sanitise: object

doc

doc: string[] = ["Deletes various privacy-related items.\n\nThe list of possible arguments can be found here:\nhttps://developer.mozilla.org/en-US/Add-ons/WebExtensions/API/browsingData/DataTypeSet\n\nAdditional, tridactyl-specific arguments are:\n- commandline: Removes the in-memory commandline history.\n- tridactyllocal: Removes all tridactyl storage local to this machine. Use it with\n commandline if you want to delete your commandline history.\n- tridactylsync: Removes all tridactyl storage associated with your Firefox Account (i.e, all user configuration, by default).\nThese arguments aren't affected by the timespan parameter.\n\nTimespan parameter:\n-t [0-9]+(m|h|d|w)\n\nExamples:\n\n- `sanitise all` -> Deletes everything\n- `sanitise history` -> Deletes all history\n- `sanitise commandline tridactyllocal tridactylsync` -> Deletes every bit of data Tridactyl holds\n- `sanitise cookies -t 3d` -> Deletes cookies that were set during the last three days."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

saveJumps

saveJumps: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "any","name": "jumps"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

scrollline

scrollline: object

doc

doc: string[] = ["Scrolls the document of its first scrollable child element by n lines.\n\nThe height of a line is defined by the site's CSS. If Tridactyl can't get it, it'll default to 22 pixels."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

scrollpage

scrollpage: object

doc

doc: string[] = ["Scrolls the document by n pages.\n\nThe height of a page is the current height of the window."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "n"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

scrollpx

scrollpx: object

doc

doc: string[] = ["Scrolls the window or any scrollable child element by a pixels on the horizontal axis and b pixels on the vertical axis."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "a"},{"kind": "number","name": "b"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

scrollto

scrollto: object

doc

doc: string[] = ["If two numbers are given, treat as x and y values to give to window.scrollTo\nIf one number is given, scroll to that percentage along a chosen axis, defaulting to the y-axis\n\nNote that if `a` is 0 or 100 and if the document is not scrollable in the given direction, Tridactyl will attempt to scroll the first scrollable element until it reaches the very bottom of that element."]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "number","name": "a"},{"kind": "union","arguments": [{"kind": "number"},{"kind": "LiteralType","name": "x"},{"kind": "LiteralType","name": "y"}],"name": "b"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

searchURL

searchURL: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "provider"},{"kind": "string","name": "query"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "URL"

searchsetkeyword

searchsetkeyword: object

doc

doc: string[] = ["Set a search engine keyword for use with *open or `set searchengine`"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "keyword"},{"kind": "string","name": "url"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

selectLast

selectLast: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "selector"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "HTMLElement"

set

set: object

doc

doc: string[] = ["Set a key value pair in config.\n\nUse to set any string values found [here](/static/docs/classes/_src_config_.default_config.html).\n\ne.g.\n set searchurls.google https://www.google.com/search?q=\n set logging.messaging info\n\nIf no value is given, the value of the of the key will be displayed"]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "string","name": "key"},{"kind": "array","type": {"kind": "string"},"name": "values"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

setclip

setclip: object

doc

doc: string[] = ["Copies a string to the clipboard/selection buffer depending on the user's preferences"]

type

type: object

arguments

arguments: object[] = [{"kind": "any","name": "str"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

showcmdline

showcmdline: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "boolean","name": "focus"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

sleep

sleep: object

doc

doc: string[] = ["Sleep time_ms milliseconds.\nThis is probably only useful for composite commands that need to wait until the previous asynchronous command has finished running."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "time_ms"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

source

source: object

doc

doc: string[] = ["Runs an RC file from disk.\n\nIf no argument given, it will try to open ~/.tridactylrc, ~/.config/tridactylrc or $XDG_CONFIG_HOME/tridactyl/tridactylrc in reverse order. You may use a `_` in place of a leading `.` if you wish, e.g, if you use Windows.\n\nOn Windows, the `~` expands to `%USERPROFILE%`.\n\nThe RC file is just a bunch of Tridactyl excmds (i.e, the stuff on this help page). Settings persist in local storage; add `sanitise tridactyllocal tridactylsync` to make it more Vim like. There's an [example file](https://raw.githubusercontent.com/cmcaine/tridactyl/master/.tridactylrc) if you want it."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "fileArr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

source_quiet

source_quiet: object

doc

doc: string[] = ["Same as [[source]] but suppresses all errors"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "fileArr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

suppress

suppress: object

doc

doc: string[] = ["Deprecated"]

type

type: object

arguments

arguments: object[] = [{"kind": "boolean","name": "preventDefault"},{"kind": "boolean","name": "stopPropagation"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

tabIndexSetActive

tabIndexSetActive: object

doc

doc: string[] = ["Switch to the tab by index (position on tab bar), wrapping round."]

type

type: object

arguments

arguments: object[] = [{"kind": "union","arguments": [{"kind": "string"},{"kind": "number"}],"name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

tabSetActive

tabSetActive: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "id"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "any"

tabclose

tabclose: object

doc

doc: string[] = ["Close a tab.\n\nKnown bug: autocompletion will make it impossible to close more than one tab at once if the list of numbers looks enough like an open tab's title or URL."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "indexes"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabclosealltoleft

tabclosealltoleft: object

doc

doc: string[] = ["Close all tabs to the left of the current one"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabclosealltoright

tabclosealltoright: object

doc

doc: string[] = ["Close all tabs to the right of the current one"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabdetach

tabdetach: object

doc

doc: string[] = ["Detach a tab, opening it in a new window."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabduplicate

tabduplicate: object

doc

doc: string[] = ["Duplicate a tab."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabfirst

tabfirst: object

doc

doc: string[] = ["Switch to the first tab. "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tablast

tablast: object

doc

doc: string[] = ["Switch to the last tab. "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabmove

tabmove: object

doc

doc: string[] = ["Move the current tab to be just in front of the index specified.\n\nKnown bug: This supports relative movement with `tabmove +pos` and `tabmove -pos`, but autocomplete doesn't know that yet and will override positive and negative indexes.\n\nPut a space in front of tabmove if you want to disable completion and have the relative indexes at the command line.\n\nBinds are unaffected."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabnext

tabnext: object

doc

doc: string[] = ["Switch to the next tab, wrapping round.\n\nIf increment is specified, move that many tabs forwards."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "increment"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabnext_gt

tabnext_gt: object

doc

doc: string[] = ["Switch to the next tab, wrapping round.\n\nIf an index is specified, go to the tab with that number (this mimics the\nbehaviour of `{count}gt` in vim, except that this command will accept a\ncount that is out of bounds (and will mod it so that it is within bounds as\nper [[tabmove]], etc))."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "index"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabonly

tabonly: object

doc

doc: string[] = ["Close all other tabs in this window "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabopen

tabopen: object

doc

doc: string[] = ["Like [[open]], but in a new tab. If no address is given, it will open the newtab page, which can be set with `set newtab [url]`\n\nUse the `-c` flag followed by a container name to open a tab in said container. Tridactyl will try to fuzzy match a name if an exact match is not found.\nUse the `-b` flag to open the tab in the background.\nThese two can be combined in any order, but need to be placed as the first arguments.\n\nUnlike Firefox's Ctrl-t shortcut, this opens tabs immediately after the\ncurrently active tab rather than at the end of the tab list because that is\nthe authors' preference.\n\nIf you would rather the Firefox behaviour `set tabopenpos last`. This\npreference also affects the clipboard, quickmarks, home, help, etc.\n\nIf you would rather the URL be opened as if you'd middle clicked it, `set\n tabopenpos related`.\n\nHinting is controlled by `relatedopenpos`"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "addressarr"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tabprev

tabprev: object

doc

doc: string[] = ["Switch to the previous tab, wrapping round.\n\nIf increment is specified, move that many tabs backwards."]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "increment"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "any"}]

kind

kind: string = "Promise"

tssReadFromCss

tssReadFromCss: object

doc

doc: string[] = ["Read text content of elements matching the given selector"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "selector"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

ttscontrol

ttscontrol: object

doc

doc: string[] = ["Cancel current reading and clear pending queue\n\nArguments:\n - stop: cancel current and pending utterances"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "action"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

ttsread

ttsread: object

doc

doc: string[] = ["Read the given text using the browser's text to speech functionality and\nthe settings currently set"]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "-t"},{"kind": "LiteralType","name": "-c"}],"name": "mode"},{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

ttsvoices

ttsvoices: object

doc

doc: string[] = ["Show a list of the voices available to the TTS system. These can be\nset in the config using `ttsvoice`"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

tutor

tutor: object

doc

doc: string[] = ["Start the tutorial"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "newtab"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

unbind

unbind: object

doc

doc: string[] = ["Unbind a sequence of keys so that they do nothing at all.\n\nSee also:\n\n - [[bind]]\n - [[reset]]"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

undo

undo: object

doc

doc: string[] = ["restore most recently closed tab in this window unless the most recently closed item was a window "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

unfocus

unfocus: object

doc

doc: string[] = ["Blur (unfocus) the active element "]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

unset

unset: object

doc

doc: string[] = ["Reset a config setting to default"]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "keys"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

updatenative

updatenative: object

doc

doc: string[] = ["Updates the native messenger if it is installed, using our GitHub repo. This is run every time Tridactyl is updated.\n\nIf you want to disable this, or point it to your own native messenger, edit the `nativeinstallcmd` setting."]

type

type: object

arguments

arguments: object[] = [{"kind": "boolean","name": "interactive"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

url2args

url2args: object

doc

doc: string[] = ["If the url of the current document matches one of your search engines, will convert it to a list of arguments that open/tabopen will understand. If the url doesn't match any search engine, returns the url without modifications.\n\nFor example, if you have searchurls.gi set to \"https://www.google.com/search?q=%s&tbm=isch\", using this function on a page you opened using \"gi butterflies\" will return \"gi butterflies\".\n\nThis is useful when combined with fillcmdline, for example like this: `bind O composite url2args | fillcmdline open`.\n\nNote that this might break with search engines that redirect you to other pages/add GET parameters that do not exist in your searchurl."]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "string"}]

kind

kind: string = "Promise"

urlincrement

urlincrement: object

doc

doc: string[] = ["Increment the current tab URL"]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "count"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

urlmodify

urlmodify: object

doc

doc: string[] = ["Open a URL made by modifying the current URL\n\nThere are several modes:\n\n* Text replace mode: `urlmodify -t <old> <new>`\n\n Replaces the first instance of the text `old` with `new`.\n * `http://example.com` -> (`-t exa peta`) -> `http://petample.com`\n\n* Regex replacment mode: `urlmodify -r <regexp> <new> [flags]`\n\n Replaces the first match of the `regexp` with `new`. You can use\n flags `i` and `g` to match case-insensitively and to match\n all instances respectively\n * `http://example.com` -> (`-r [ea] X g`) -> `http://XxXmplX.com`\n\n* Query replace mode: `urlmodify -q <query> <new_val>`\n\n Replace the value of a query with a new one:\n * `http://e.com?id=foo` -> (`-q id bar`) -> `http://e.com?id=bar\n *\n * * Query delete mode: `urlmodify -Q <query>`\n *\n * Deletes the given query (and the value if any):\n * * `http://e.com?id=foo&page=1` -> (`-Q id`) -> `http://e.com?page=1`\n *\n * * Graft mode: `urlmodify -g <graft_point> <new_path_tail>`\n *\n * \"Grafts\" a new tail on the URL path, possibly removing some of the old\n * tail. Graft point indicates where the old URL is truncated before adding\n * the new path.\n *\n * * `graft_point` >= 0 counts path levels, starting from the left\n * (beginning). 0 will append from the \"root\", and no existing path will\n * remain, 1 will keep one path level, and so on.\n * * `graft_point` < 0 counts from the right (i.e. the end of the current\n * path). -1 will append to the existing path, -2 will remove the last path\n * level, and so on.\n *\n * ```text\n http://website.com/this/is/the/path/component\n Graft point: ^ ^ ^ ^ ^ ^\n From left: 0 1 2 3 4 5\n From right: -6 -5 -4 -3 -2 -1\n ```\n *\n * Examples:\n *\n * * `http://e.com/issues/42` -> (`-g 0 foo`) -> `http://e.com/foo`\n * * `http://e.com/issues/42` -> (`-g 1 foo`) -> `http://e.com/issues/foo`\n * * `http://e.com/issues/42` -> (`-g -1 foo`) -> `http://e.com/issues/42/foo`\n * * `http://e.com/issues/42` -> (`-g -2 foo`) -> `http://e.com/issues/foo`\n *\n * @param mode The replace mode:\n * * -t text replace\n * * -r regexp replace\n * * -q replace the value of the given query\n * * -Q delete the given query\n * * -g graft a new path onto URL or parent path of it\n * @param replacement the replacement arguments (depends on mode):\n * * -t <old> <new>\n * * -r <regexp> <new> [flags]\n * * -q <query> <new_val>\n * * -Q <query>\n * * -g <graftPoint> <newPathTail>\n *"]

type

type: object

arguments

arguments: (object | object)[] = [{"kind": "union","arguments": [{"kind": "LiteralType","name": "-t"},{"kind": "LiteralType","name": "-r"},{"kind": "LiteralType","name": "-q"},{"kind": "LiteralType","name": "-Q"},{"kind": "LiteralType","name": "-g"}],"name": "mode"},{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

urlparent

urlparent: object

doc

doc: string[] = ["Go to the parent URL of the current tab's URL"]

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "count"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

urlroot

urlroot: object

doc

doc: string[] = ["Go to the root domain of the current URL"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

version

version: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

viewconfig

viewconfig: object

doc

doc: string[] = ["Opens the current configuration in Firefox's native JSON viewer in the current tab.\n\nNB: Tridactyl cannot run on this page!"]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "key"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

viewcontainers

viewcontainers: object

doc

doc: string[] = ["Shows a list of the current containers in Firefox's native JSON viewer in the current tab.\n\nNB: Tridactyl cannot run on this page!"]

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

viewsource

viewsource: object

doc

doc: string[] = ["Display the (HTML) source of the current page.\n\nBehaviour can be changed by the 'viewsource' setting.\n\nIf the 'viewsource' setting is set to 'default' rather than 'tridactyl',\nthe url the source of which should be displayed can be given as argument.\nOtherwise, the source of the current document will be displayed."]

type

type: object

arguments

arguments: object[] = [{"kind": "string","name": "url"}]

kind

kind: string = "function"

type

type: object

kind

kind: string = "void"

winclose

winclose: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: undefined[] = []

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

winopen

winopen: object

doc

doc: string[] = ["Like [[tabopen]], but in a new window "]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "args"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

yank

yank: object

doc

doc: string[] = ["Copy content to clipboard without feedback. Use `clipboard yank` for interactive use."]

type

type: object

arguments

arguments: object[] = [{"kind": "array","type": {"kind": "string"},"name": "content"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"

zoom

zoom: object

doc

doc: undefined[] = []

type

type: object

arguments

arguments: object[] = [{"kind": "number","name": "level"},{"kind": "string","name": "rel"}]

kind

kind: string = "function"

type

type: object

arguments

arguments: object[] = [{"kind": "void"}]

kind

kind: string = "Promise"