Generated from excmds.ts. Don't edit this file!

Index

Functions

Functions

addTridactylEditorClass

  • addTridactylEditorClass(selector: string): void
  • Parameters

    • selector: string

    Returns void

apropos

  • apropos(...helpItems: string[]): Promise<any>
  • Parameters

    • Rest ...helpItems: string[]

    Returns Promise<any>

autocmd

  • autocmd(event: string, url: string, ...excmd: string[]): Promise<any>
  • Parameters

    • event: string
    • url: string
    • Rest ...excmd: string[]

    Returns Promise<any>

autocmddelete

  • autocmddelete(event: string, url: string): Promise<any>
  • Parameters

    • event: string
    • url: string

    Returns Promise<any>

autocontain

  • autocontain(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

back

  • back(n?: number): void
  • Parameters

    • Default value n: number = 1

    Returns void

bind

  • bind(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

bindurl

  • bindurl(pattern: string, mode: string, keys: string, ...excmd: string[]): Promise<any>
  • Parameters

    • pattern: string
    • mode: string
    • keys: string
    • Rest ...excmd: string[]

    Returns Promise<any>

blacklistadd

  • blacklistadd(url: string): Promise<any>
  • Parameters

    • url: string

    Returns Promise<any>

bmark

  • bmark(url?: string, ...titlearr: string[]): Promise<any>
  • Parameters

    • Optional url: string
    • Rest ...titlearr: string[]

    Returns Promise<any>

bmarks

  • bmarks(opt: string, ...urlarr: string[]): Promise<any>
  • Parameters

    • opt: string
    • Rest ...urlarr: string[]

    Returns Promise<any>

changelistjump

  • changelistjump(n?: number): Promise<any>
  • Parameters

    • Optional n: number

    Returns Promise<any>

clearsearchhighlight

  • clearsearchhighlight(): void
  • Returns void

clipboard

  • clipboard(excmd?: "open" | "yank" | "yankshort" | "yankcanon" | "yanktitle" | "yankmd" | "xselpaste" | "tabopen", ...toYank: string[]): Promise<any>
  • Parameters

    • Default value excmd: "open" | "yank" | "yankshort" | "yankcanon" | "yanktitle" | "yankmd" | "xselpaste" | "tabopen" = "open"
    • Rest ...toYank: string[]

    Returns Promise<any>

colourscheme

  • colourscheme(themename: string): Promise<any>
  • Parameters

    • themename: string

    Returns Promise<any>

comclear

  • comclear(name: string): Promise<any>
  • Parameters

    • name: string

    Returns Promise<any>

command

  • command(name: string, ...definition: string[]): Promise<any>
  • Parameters

    • name: string
    • Rest ...definition: string[]

    Returns Promise<any>

composite

  • composite(...cmds: string[]): Promise<any>
  • Parameters

    • Rest ...cmds: string[]

    Returns Promise<any>

containerclose

  • containerclose(name: string): Promise<any>
  • Parameters

    • name: string

    Returns Promise<any>

containercreate

  • containercreate(name: string, color?: string, icon?: string): Promise<any>
  • Parameters

    • name: string
    • Optional color: string
    • Optional icon: string

    Returns Promise<any>

containerdelete

  • containerdelete(name: string): Promise<any>
  • Parameters

    • name: string

    Returns Promise<any>

containerupdate

  • containerupdate(name: string, uname: string, ucolor: string, uicon: string): Promise<any>
  • Parameters

    • name: string
    • uname: string
    • ucolor: string
    • uicon: string

    Returns Promise<any>

credits

  • credits(): Promise<any>
  • Returns Promise<any>

cssparse

  • cssparse(...css: string[]): Promise<any>
  • Parameters

    • Rest ...css: string[]

    Returns Promise<any>

echo

  • echo(...str: string[]): Promise<any>
  • Parameters

    • Rest ...str: string[]

    Returns Promise<any>

editor

  • editor(): Promise<void | any[]>
  • Returns Promise<void | any[]>

escapehatch

  • escapehatch(): Promise<any>
  • Returns Promise<any>

exclaim

  • exclaim(...str: string[]): Promise<any>
  • Parameters

    • Rest ...str: string[]

    Returns Promise<any>

exclaim_quiet

  • exclaim_quiet(...str: string[]): Promise<any>
  • Parameters

    • Rest ...str: string[]

    Returns Promise<any>

extoptions

  • extoptions(...optionNameArgs: string[]): Promise<any>
  • Parameters

    • Rest ...optionNameArgs: string[]

    Returns Promise<any>

fillcmdline

  • fillcmdline(...strarr: string[]): Promise<any>
  • Parameters

    • Rest ...strarr: string[]

    Returns Promise<any>

fillcmdline_nofocus

  • fillcmdline_nofocus(...strarr: string[]): Promise<any>
  • Parameters

    • Rest ...strarr: string[]

    Returns Promise<any>

fillcmdline_notrail

  • fillcmdline_notrail(...strarr: string[]): Promise<any>
  • Parameters

    • Rest ...strarr: string[]

    Returns Promise<any>

fillcmdline_tmp

  • fillcmdline_tmp(ms: number, ...strarr: string[]): Promise<unknown>
  • Parameters

    • ms: number
    • Rest ...strarr: string[]

    Returns Promise<unknown>

fillinput

  • fillinput(selector: string, ...content: string[]): void
  • Parameters

    • selector: string
    • Rest ...content: string[]

    Returns void

find

  • find(...args: string[]): Promise<void>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<void>

findnext

  • findnext(n?: number): Promise<void>
  • Parameters

    • Default value n: number = 1

    Returns Promise<void>

fixamo

  • fixamo(): Promise<any>
  • Returns Promise<any>

fixamo_quiet

  • fixamo_quiet(): Promise<any>
  • Returns Promise<any>

focusbyid

  • focusbyid(id: string): void
  • Parameters

    • id: string

    Returns void

focusinput

  • focusinput(nth: number | string): void
  • Parameters

    • nth: number | string

    Returns void

followpage

  • followpage(rel?: "next" | "prev"): void
  • Parameters

    • Default value rel: "next" | "prev" = "next"

    Returns void

forward

  • forward(n?: number): void
  • Parameters

    • Default value n: number = 1

    Returns void

fullscreen

  • fullscreen(): Promise<any>
  • Returns Promise<any>

get

  • get(...keys: string[]): Promise<any>
  • Parameters

    • Rest ...keys: string[]

    Returns Promise<any>

getInputSelector

  • getInputSelector(): any
  • Returns any

getNativeVersion

  • getNativeVersion(): Promise<string>
  • Returns Promise<string>

getRssLinks

  • getRssLinks(): Promise<Array<{ title: string; type: string; url: string }>>
  • Returns Promise<Array<{ title: string; type: string; url: string }>>

getclip

  • getclip(fromm?: "clipboard" | "selection"): Promise<any>
  • Parameters

    • Optional fromm: "clipboard" | "selection"

    Returns Promise<any>

getinput

  • getinput(): string
  • Returns string

geturlsforlinks

  • geturlsforlinks(reltype?: string, rel: string): Promise<unknown[]>
  • Parameters

    • Default value reltype: string = "rel"
    • rel: string

    Returns Promise<unknown[]>

gobble

  • gobble(nChars: number, endCmd: string): Promise<void>
  • Parameters

    • nChars: number
    • endCmd: string

    Returns Promise<void>

guiset

  • guiset(rule: string, option: string): Promise<any>
  • Parameters

    • rule: string
    • option: string

    Returns Promise<any>

guiset_quiet

  • guiset_quiet(rule: string, option: string): Promise<any>
  • Parameters

    • rule: string
    • option: string

    Returns Promise<any>

help

  • help(...helpItems: string[]): Promise<any>
  • Parameters

    • Rest ...helpItems: string[]

    Returns Promise<any>

hidecmdline

  • hidecmdline(): void
  • Returns void

hint

  • hint(option?: string, selectors?: string, ...rest: string[]): Promise<any>
  • Parameters

    • Optional option: string
    • Optional selectors: string
    • Rest ...rest: string[]

    Returns Promise<any>

home

  • home(all?: "false" | "true"): Promise<any>
  • Parameters

    • Default value all: "false" | "true" = "false"

    Returns Promise<any>

issue

  • issue(): Promise<any>
  • Returns Promise<any>

js

  • js(...str: string[]): Promise<any>
  • Parameters

    • Rest ...str: string[]

    Returns Promise<any>

jsb

  • jsb(...str: string[]): Promise<any>
  • Parameters

    • Rest ...str: string[]

    Returns Promise<any>

jumpnext

  • jumpnext(n?: number): Promise<void>
  • Parameters

    • Default value n: number = 1

    Returns Promise<void>

jumpprev

  • jumpprev(n?: number): Promise<void>
  • Parameters

    • Default value n: number = 1

    Returns Promise<void>

keyfeed

  • keyfeed(mapstr: string): Promise<void>
  • Parameters

    • mapstr: string

    Returns Promise<void>

keymap

  • keymap(source: string, target: string): Promise<any>
  • Parameters

    • source: string
    • target: string

    Returns Promise<any>

loadaucmds

  • loadaucmds(cmdType: "DocStart" | "DocLoad" | "DocEnd" | "TabEnter" | "TabLeft" | "FullscreenEnter" | "FullscreenLeft" | "FullscreenChange"): Promise<void>
  • Parameters

    • cmdType: "DocStart" | "DocLoad" | "DocEnd" | "TabEnter" | "TabLeft" | "FullscreenEnter" | "FullscreenLeft" | "FullscreenChange"

    Returns Promise<void>

loadtheme

  • loadtheme(themename: string): Promise<any>
  • Parameters

    • themename: string

    Returns Promise<any>

mktridactylrc

  • mktridactylrc(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

mode

  • Parameters

    Returns void

mute

  • mute(...muteArgs: string[]): Promise<void>
  • Parameters

    • Rest ...muteArgs: string[]

    Returns Promise<void>

native

  • native(): Promise<any>
  • Returns Promise<any>

nativeinstall

  • nativeinstall(): Promise<any>
  • Returns Promise<any>

nativeopen

  • nativeopen(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

neo_mouse_mode

  • neo_mouse_mode(): void
  • Returns void

nmode

  • nmode(mode: string, n: number, ...endexArr: string[]): Promise<void>
  • Parameters

    • mode: string
    • n: number
    • Rest ...endexArr: string[]

    Returns Promise<void>

no_mouse_mode

  • no_mouse_mode(): void
  • Returns void

open

  • open(...urlarr: string[]): Promise<any>
  • Parameters

    • Rest ...urlarr: string[]

    Returns Promise<any>

open_quiet

  • open_quiet(...urlarr: string[]): Promise<any>
  • Parameters

    • Rest ...urlarr: string[]

    Returns Promise<any>

perfdump

  • perfdump(...filters: string[]): Promise<any>
  • Parameters

    • Rest ...filters: string[]

    Returns Promise<any>

perfhistogram

  • perfhistogram(...filters: string[]): Promise<any>
  • Parameters

    • Rest ...filters: string[]

    Returns Promise<any>

pin

  • pin(): Promise<any>
  • Returns Promise<any>

qall

  • qall(): Promise<any>
  • Returns Promise<any>

quickmark

  • quickmark(key: string, ...addressarr: string[]): Promise<any>
  • Parameters

    • key: string
    • Rest ...addressarr: string[]

    Returns Promise<any>

reader

  • reader(): Promise<any>
  • Returns Promise<any>

recontain

  • recontain(containerName: string): Promise<any>
  • Parameters

    • containerName: string

    Returns Promise<any>

reload

  • reload(n?: number, hard?: boolean): Promise<any>
  • Parameters

    • Default value n: number = 1
    • Default value hard: boolean = false

    Returns Promise<any>

reloadall

  • reloadall(hard?: boolean): Promise<any>
  • Parameters

    • Default value hard: boolean = false

    Returns Promise<any>

reloadallbut

  • reloadallbut(hard?: boolean): Promise<any>
  • Parameters

    • Default value hard: boolean = false

    Returns Promise<any>

reloadhard

  • reloadhard(n?: number): Promise<any>
  • Parameters

    • Default value n: number = 1

    Returns Promise<any>

removeTridactylEditorClass

  • removeTridactylEditorClass(selector: string): void
  • Parameters

    • selector: string

    Returns void

removepref

  • removepref(key: string): Promise<any>
  • Parameters

    • key: string

    Returns Promise<any>

repeat

  • repeat(n?: number, ...exstr: string[]): Promise<any>
  • Parameters

    • Default value n: number = 1
    • Rest ...exstr: string[]

    Returns Promise<any>

reset

  • reset(mode: string, key: string): Promise<any>
  • Parameters

    • mode: string
    • key: string

    Returns Promise<any>

reseturl

  • reseturl(pattern: string, mode: string, key: string): Promise<any>
  • Parameters

    • pattern: string
    • mode: string
    • key: string

    Returns Promise<any>

restart

  • restart(): Promise<any>
  • Returns Promise<any>

rot13

  • rot13(n: number): void
  • Parameters

    • n: number

    Returns void

rssexec

  • rssexec(url: string, type?: string, ...title: string[]): Promise<any>
  • Parameters

    • url: string
    • Optional type: string
    • Rest ...title: string[]

    Returns Promise<any>

run_exstr

  • run_exstr(...commands: string[]): Promise<any>
  • Parameters

    • Rest ...commands: string[]

    Returns Promise<any>

sanitise

  • sanitise(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

saveas

  • saveas(...filename: string[]): Promise<any>
  • Parameters

    • Rest ...filename: string[]

    Returns Promise<any>

scrollline

  • scrollline(n?: number, mult?: number): Promise<boolean>
  • Parameters

    • Default value n: number = 1
    • Default value mult: number = 1

    Returns Promise<boolean>

scrollpage

  • scrollpage(n?: number): Promise<any>
  • Parameters

    • Default value n: number = 1

    Returns Promise<any>

scrollpx

  • scrollpx(a: number, b: number): Promise<any>
  • Parameters

    • a: number
    • b: number

    Returns Promise<any>

scrollto

  • scrollto(a: number | string, b?: number | "x" | "y"): Promise<any>
  • Parameters

    • a: number | string
    • Default value b: number | "x" | "y" = "y"

    Returns Promise<any>

searchsetkeyword

  • searchsetkeyword(): Promise<any>
  • Returns Promise<any>

set

  • set(key: string, ...values: string[]): Promise<any>
  • Parameters

    • key: string
    • Rest ...values: string[]

    Returns Promise<any>

setnull

  • setnull(...keys: string[]): Promise<any>
  • Parameters

    • Rest ...keys: string[]

    Returns Promise<any>

setpref

  • setpref(key: string, ...value: string[]): Promise<any>
  • Parameters

    • key: string
    • Rest ...value: string[]

    Returns Promise<any>

seturl

  • seturl(pattern: string, key: string, ...values: string[]): Promise<void>
  • Parameters

    • pattern: string
    • key: string
    • Rest ...values: string[]

    Returns Promise<void>

shellescape

  • shellescape(...quoteme: string[]): Promise<string>
  • Escape command for safe use in shell with composite. E.g: composite js MALICIOUS_WEBSITE_FUNCTION() | shellescape | exclaim ls

    Parameters

    • Rest ...quoteme: string[]

    Returns Promise<string>

showcmdline

  • showcmdline(focus?: boolean): Promise<void>
  • Parameters

    • Default value focus: boolean = true

    Returns Promise<void>

sleep

  • sleep(time_ms: number): Promise<unknown>
  • Parameters

    • time_ms: number

    Returns Promise<unknown>

snow_mouse_mode

  • snow_mouse_mode(): void
  • Returns void

source

  • source(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

source_quiet

  • source_quiet(args: string[]): Promise<any>
  • Parameters

    • args: string[]

    Returns Promise<any>

tab

  • tab(index: number | "#"): Promise<any>
  • Parameters

    • index: number | "#"

    Returns Promise<any>

taball

  • taball(id: string): Promise<any>
  • Parameters

    • id: string

    Returns Promise<any>

tabclose

  • tabclose(...indexes: string[]): Promise<any>
  • Parameters

    • Rest ...indexes: string[]

    Returns Promise<any>

tabcloseallto

  • tabcloseallto(side: string): Promise<any>
  • Parameters

    • side: string

    Returns Promise<any>

tabdetach

  • tabdetach(index?: number): Promise<any>
  • Parameters

    • Optional index: number

    Returns Promise<any>

tabduplicate

  • tabduplicate(index?: number): Promise<any>
  • Parameters

    • Optional index: number

    Returns Promise<any>

tabgrab

  • tabgrab(id: string): Promise<any>
  • Parameters

    • id: string

    Returns Promise<any>

tabmove

  • tabmove(index?: string): Promise<any>
  • Parameters

    • Default value index: string = "$"

    Returns Promise<any>

tabnext

  • tabnext(increment?: number): Promise<any>
  • Parameters

    • Default value increment: number = 1

    Returns Promise<any>

tabnext_gt

  • tabnext_gt(index?: number): Promise<any>
  • Parameters

    • Optional index: number

    Returns Promise<any>

tabonly

  • tabonly(): Promise<any>
  • Returns Promise<any>

tabopen

  • tabopen(...addressarr: string[]): Promise<any>
  • Parameters

    • Rest ...addressarr: string[]

    Returns Promise<any>

tabprev

  • tabprev(increment?: number): Promise<any>
  • Parameters

    • Default value increment: number = 1

    Returns Promise<any>

tabpush

  • tabpush(windowId: number): Promise<any>
  • Parameters

    • windowId: number

    Returns Promise<any>

tabqueue

  • tabqueue(...addresses: string[]): Promise<any>
  • Parameters

    • Rest ...addresses: string[]

    Returns Promise<any>

tssReadFromCss

  • tssReadFromCss(selector: string): void
  • Read text content of elements matching the given selector

    Parameters

    • selector: string

      the selector to match elements

    Returns void

ttscontrol

  • ttscontrol(action: string): Promise<void>
  • Parameters

    • action: string

    Returns Promise<void>

ttsread

  • ttsread(mode: "-t" | "-c", ...args: string[]): Promise<void>
  • Parameters

    • mode: "-t" | "-c"
    • Rest ...args: string[]

    Returns Promise<void>

ttsvoices

  • ttsvoices(): Promise<any>
  • Returns Promise<any>

tutor

  • tutor(newtab?: string): Promise<any>
  • Parameters

    • Optional newtab: string

    Returns Promise<any>

unbind

  • unbind(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

unbindurl

  • unbindurl(pattern: string, mode: string, keys: string): Promise<any>
  • Parameters

    • pattern: string
    • mode: string
    • keys: string

    Returns Promise<any>

undo

  • undo(item?: string): Promise<number>
  • Parameters

    • Default value item: string = "recent"

    Returns Promise<number>

unfocus

  • unfocus(): void
  • Returns void

unloadtheme

  • unloadtheme(themename: string): Promise<any>
  • Parameters

    • themename: string

    Returns Promise<any>

unset

  • unset(...keys: string[]): Promise<any>
  • Parameters

    • Rest ...keys: string[]

    Returns Promise<any>

unseturl

  • unseturl(pattern: string, key: string): Promise<void>
  • Parameters

    • pattern: string
    • key: string

    Returns Promise<void>

updatecheck

  • updatecheck(source?: "manual" | "auto_polite" | "auto_impolite"): Promise<any>
  • Parameters

    • Default value source: "manual" | "auto_polite" | "auto_impolite" = "manual"

    Returns Promise<any>

updatenative

  • updatenative(interactive?: boolean): Promise<any>
  • Parameters

    • Default value interactive: boolean = true

    Returns Promise<any>

url2args

  • url2args(): Promise<string>
  • Returns Promise<string>

urlincrement

  • urlincrement(count?: number): void
  • Parameters

    • Default value count: number = 1

    Returns void

urlmodify

  • urlmodify(mode: "-t" | "-r" | "-s" | "-q" | "-Q" | "-g", ...args: string[]): void
  • Parameters

    • mode: "-t" | "-r" | "-s" | "-q" | "-Q" | "-g"
    • Rest ...args: string[]

    Returns void

urlmodify_js

  • urlmodify_js(mode: "-t" | "-r" | "-s" | "-q" | "-Q" | "-g", ...args: string[]): any
  • Parameters

    • mode: "-t" | "-r" | "-s" | "-q" | "-Q" | "-g"
    • Rest ...args: string[]

    Returns any

urlparent

  • urlparent(count?: number): void
  • Parameters

    • Default value count: number = 1

    Returns void

urlroot

  • urlroot(): void
  • Returns void

version

  • version(): Promise<any>
  • Returns Promise<any>

viewconfig

  • viewconfig(key?: string): void
  • Parameters

    • Optional key: string

    Returns void

viewcontainers

  • viewcontainers(): Promise<void>
  • Returns Promise<void>

viewsource

  • viewsource(url?: string): void
  • Parameters

    • Default value url: string = ""

    Returns void

winclose

  • winclose(...ids: string[]): Promise<any>
  • Parameters

    • Rest ...ids: string[]

    Returns Promise<any>

winmerge

  • winmerge(...windowIds: string[]): Promise<any>
  • Parameters

    • Rest ...windowIds: string[]

    Returns Promise<any>

winopen

  • winopen(...args: string[]): Promise<any>
  • Parameters

    • Rest ...args: string[]

    Returns Promise<any>

yank

  • yank(...content: string[]): Promise<any>
  • Parameters

    • Rest ...content: string[]

    Returns Promise<any>

zoom

  • zoom(level?: number, rel?: string): Promise<any>
  • Parameters

    • Default value level: number = 0
    • Default value rel: string = "false"

    Returns Promise<any>