2
2
mirror of https://github.com/Hilbis/Hilbish synced 2025-07-04 10:12:03 +00:00
Hilbish/docs/api/hilbish/hilbish.aliases.md
sammyette 7c1984135b
docs: add detailed parameter listing, change interface to modules
there are a few changes here
- documentation of each parameter separately has been added
to the generated text docs
- interfaces have been renamed to modules. this was honestly a pointless
and confusing distinction (interfaces are tables for modules that are
lua modules). it also makes it so that (formerly) interfaces and
modules line up with each other on the doc list

im not sure what else i did, these are old changes
2023-08-26 11:30:51 -04:00

34 lines
795 B
Markdown

---
title: Module hilbish.aliases
description: command aliasing
layout: doc
menu:
docs:
parent: "API"
---
## 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() -> table\<string, string>
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) -> command (string)
Tries to resolve an alias to its command.
#### Parameters
This function has no parameters.