aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSteven Arcangeli <stevearc@stevearc.com>2023-09-07 17:57:32 -0700
committerSteven Arcangeli <stevearc@stevearc.com>2023-09-07 18:22:30 -0700
commit4c67568df62e905c6d4194a602a65490f78ffc35 (patch)
tree2e2cd6514bdaf94cfcc3387652ae2c7605570d23 /README.md
parent1bd3c1bffc6b5cdba83264f3be5bb1d282c13707 (diff)
refactor: make get_formatter_info a public method
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
index fa3c907..8331dae 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ Lightweight yet powerful formatter plugin for Neovim
- [format(opts, callback)](#formatopts-callback)
- [list_formatters(bufnr)](#list_formattersbufnr)
- [list_all_formatters()](#list_all_formatters)
+ - [get_formatter_info(formatter, bufnr)](#get_formatter_infoformatter-bufnr)
- [Acknowledgements](#acknowledgements)
<!-- /TOC -->
@@ -391,6 +392,16 @@ Retrieve the available formatters for a buffer
`list_all_formatters(): conform.FormatterInfo[]` \
List information about all filetype-configured formatters
+
+### get_formatter_info(formatter, bufnr)
+
+`get_formatter_info(formatter, bufnr): conform.FormatterInfo` \
+Get information about a formatter (including availability)
+
+| Param | Type | Desc |
+| --------- | -------------- | ---- |
+| formatter | `string` | |
+| bufnr | `nil\|integer` | |
<!-- /API -->
## Acknowledgements