Add export of Location type

vfile · Feb 7, 2023 · de2ad12 · de2ad12
1 parent 20a0212
commit de2ad12
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/index.js b/index.js
@@ -1 +1,5 @@
+/**
+ * @typedef {import('./lib/index.js').Location} Location
+ */
+
 export {location} from './lib/index.js'
diff --git a/lib/index.js b/lib/index.js
@@ -37,7 +37,7 @@
  *   Offset or `-1` for invalid or out of bounds input.
  *
  * @typedef Location
- *   Index with accessors.
+ *   Accessors for index.
  * @property {ToPoint} toPoint
  *   Get a line/column-based `point` from `offset`.
  * @property {ToOffset} toOffset
@@ -51,6 +51,7 @@
  * @param {VFile | Value} file
  *   File to index.
  * @returns {Location}
+ *   Accessors for index.
  */
 export function location(file) {
   const value = String(file)