mirror of https://github.com/Hilbis/Hilbish
33 lines
7.7 KiB
XML
33 lines
7.7 KiB
XML
|
<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Module hilbish on Hilbish</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/</link><description>Recent content in Module hilbish on Hilbish</description><generator>Hugo -- gohugo.io</generator><language>en-us</language><atom:link href="https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/index.xml" rel="self" type="application/rss+xml"/><item><title>Module hilbish.aliases</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.aliases/</guid><description>Introduction The alias interface deals with all command aliases in Hilbish.
|
||
|
|
Functions hilbish.aliases.add(alias, cmd) This is an alias (ha) for the hilbish.alias function.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.aliases.delete(name) Removes an alias.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.aliases.list() -&gt; table&lt;string, string&gt; Get a table of all aliases, with string keys as the alias and the value as the command.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.aliases.resolve(alias) -&gt; command (string) Tries to resolve an alias to its command.</description></item><item><title>Module hilbish.completions</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.completions/</guid><description>Introduction The completions interface deals with tab completions.
|
||
|
|
Functions hilbish.completions.call(name, query, ctx, fields) -&gt; completionGroups (table), prefix (string) Calls a completer function. This is mainly used to call a command completer, which will have a name in the form of command.name, example: command.git. You can check doc completions for info on the completionGroups return value.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.completions.handler(line, pos) The handler function is the callback for tab completion in Hilbish.</description></item><item><title>Module hilbish.editor</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.editor/</guid><description>Introduction The hilbish.editor interface provides functions to directly interact with the line editor in use.
|
||
|
|
Functions hilbish.editor.getLine() -&gt; string Returns the current input line.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.editor.getVimRegister(register) -&gt; string Returns the text that is at the register.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.editor.insert(text) Inserts text into the line.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.editor.setVimRegister(register, text) Sets the vim register at register to hold the passed text.</description></item><item><title>Module hilbish.history</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.history/</guid><description>Introduction The history interface deals with command history. This includes the ability to override functions to change the main method of saving history.
|
||
|
|
Functions hilbish.history.add(cmd) Adds a command to the history.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.history.all() -&gt; table Retrieves all history.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.history.clear() Deletes all commands from the history.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.history.get(idx) Retrieves a command from the history based on the idx.</description></item><item><title>Module hilbish.jobs</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.jobs/</guid><description>Introduction Manage interactive jobs in Hilbish via Lua.
|
||
|
|
Jobs are the name of background tasks/commands. A job can be started via interactive usage or with the functions defined below for use in external runners.
|
||
|
|
Functions hilbish.jobs.add(cmdstr, args, execPath) Adds a new job to the job table. Note that this does not immediately run it.
|
||
|
|
Parameters This function has no parameters.
|
||
|
|
hilbish.jobs.all() -&gt; table&lt;Job&gt; Returns a table of all job objects.</description></item><item><title>Module hilbish.os</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.os/</guid><description> Introduction The os interface provides simple text information properties about the current OS on the systen. This mainly includes the name and version.
|
||
|
|
Interface fields family: Family name of the current OS name: Pretty name of the current OS version: Version of the current OS</description></item><item><title>Module hilbish.runner</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.runner/</guid><description>Introduction The runner interface contains functions that allow the user to change how Hilbish interprets interactive input. Users can add and change the default runner for interactive input to any language or script of their choosing. A good example is using it to write command in Fennel.
|
||
|
|
Functions hilbish.runner.setMode(cb) This is the same as the hilbish.runnerMode function. It takes a callback, which will be used to execute all interactive input.</description></item><item><title>Module hilbish.timers</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.timers/</guid><description>Introduction If you ever want to run a piece of code on a timed interval, or want to wait a few seconds, you don&rsquo;t have to rely on timing tricks, as Hilbish has a timer API to set intervals and timeouts.
|
||
|
|
These are the simple functions hilbish.interval and hilbish.timeout (doc accessible with doc hilbish). But if you want slightly more control over them, there is the hilbish.timers interface. It allows you to get a timer via ID and control them.</description></item><item><title>Module hilbish.userDir</title><link>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://rosettea.github.io/Hilbish/versions/doc-improvements/docs/api/hilbish/hilbish.userdir/</guid><description> Introduction This interface just contains properties to know about certain user directories. It is equivalent to XDG on Linux and gets the user&rsquo;s preferred directories for configs and data.
|
||
|
|
Interface fields config: The user&rsquo;s config directory data: The user&rsquo;s directory for program data</description></item></channel></rss>
|