feat: Index

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

src/__tests__/index-number.spec-d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Type Tests - Index
+ * @module unist-util-types/tests/unit-d/Index
+ */
+
+import type TestSubject from '../index-number'
+
+describe('unit-d:Index', () => {
+  it('should equal number', () => {
+    expectTypeOf<TestSubject>().toEqualTypeOf<number>()
+  })
+})

src/index-number.ts

@@ -0,0 +1,14 @@
+/**
+ * @file Index
+ * @module unist-util-types/Index
+ */
+
+/**
+ * Number of preceding [*siblings*][1] of a [*child*][2] node.
+ *
+ * [1]: https://github.com/syntax-tree/unist#sibling
+ * [2]: https://github.com/syntax-tree/unist#child
+ */
+type Index = number
+
+export type { Index as default }

src/index.ts

@@ -8,6 +8,7 @@ export type { default as Children } from './children'
 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 Index } from './index-number'
 export type { default as IsAncestor } from './is-ancestor'
 export type { default as IsParent } from './is-parent'
 export type { default as Parents } from './parents'