Hilbish/docs/api/hilbish/hilbish.completions.md

30 lines
936 B
Markdown
Raw Permalink Normal View History

---
title: Interface hilbish.completions
description: tab completions
layout: doc
menu:
docs:
parent: "API"
---
## Introduction
The completions interface deals with tab completions.
## Functions
2023-02-07 22:19:24 +00:00
### call(name, query, ctx, fields) -> 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
2023-02-07 22:19:24 +00:00
of `command.name`, example: `command.git`.
You can check `doc completions` for info on the `completionGroups` return value.
### handler(line, pos)
The handler function is the callback for tab completion in Hilbish.
You can check the completions doc for more info.
2023-02-07 22:19:24 +00:00
### bins(query, ctx, fields) -> entries (table), prefix (string)
Returns binary/executale completion candidates based on the provided query.
2023-02-07 22:19:24 +00:00
### files(query, ctx, fields) -> entries (table), prefix (string)
Returns file completion candidates based on the provided query.