feat: PositionalInfo

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

src/__tests__/positional-info.spec-d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Type Tests - PositionalInfo
+ * @module unist-util-types/tests/unit-d/PositionalInfo
+ */
+
+import type * as mdast from 'mdast'
+import type TestSubject from '../positional-info'
+
+describe('unit-d:PositionalInfo', () => {
+  it('should equal Pick<T, "position">', () => {
+    // Arrange
+    type T = mdast.Code
+
+    // Expect
+    expectTypeOf<TestSubject<T>>().toEqualTypeOf<Pick<T, 'position'>>()
+  })
+})

src/index.ts

@@ -6,4 +6,5 @@
 export type { default as Decrement } from './decrement'
 export type { default as InclusiveDescendant } from './descendant-inclusive'
 export type { default as Increment } from './increment'
+export type { default as PositionalInfo } from './positional-info'
 export type { default as Uint } from './uint'

src/positional-info.ts

@@ -0,0 +1,20 @@
+/**
+ * @file PositionalInfo
+ * @module unist-util-types/PositionalInfo
+ */
+
+import type { Node } from 'unist'
+
+/**
+ * Object containing the [*positional information*][1] of [node][2] `T`.
+ *
+ * [1]: https://github.com/syntax-tree/unist#positional-information
+ * [2]: https://github.com/syntax-tree/unist#node
+ *
+ * @see {@linkcode Node}
+ *
+ * @template {Node} [T=Node] - Node to get positional information from
+ */
+type PositionalInfo<T extends Node = Node> = Pick<T, 'position'>
+
+export type { PositionalInfo as default }