Document options.titleFormat

Signed-off-by: Boris Bera <beraboris@gmail.com>
2023-11-05 06:19:07 -05:00
parent 561094f585
commit b39c242667
1 changed files with 7 additions and 0 deletions
@@ -157,6 +157,13 @@ function mapToItems(info: { [key: string]: string }, options: Options) {
 }

 interface Options {
+  /**
+   * Function to format the keys from the `metadata` object. Defaults to
+   * startCase from the lodash library.
+   * @param key A key within the `metadata`
+   * @returns Formatted key
+   * @see {@link startCase}
+   */
  titleFormat?: (key: string) => string;
 }