feat(hooks): ResolveHookResult

Signed-off-by: Lexus Drumgold <[email protected]>

src/hooks/__tests__/resolve-result.spec-d.ts

@@ -0,0 +1,29 @@
+/**
+ * @file Type Tests - ResolveHookResult
+ * @module esm-types/hooks/tests/unit-d/ResolveHookResult
+ */
+
+import type { Format } from '#src/enums'
+import type { ResolvedModuleUrl } from '#src/types'
+import type { Nilable } from '@flex-development/tutils'
+import type TestSubject from '../resolve-result'
+
+describe('unit-d:hooks/ResolveHookResult', () => {
+  it('should match [format?: Nilable<Format>]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('format')
+      .toEqualTypeOf<Nilable<Format>>()
+  })
+
+  it('should match [shortCircuit?: boolean | undefined]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('shortCircuit')
+      .toEqualTypeOf<boolean | undefined>()
+  })
+
+  it('should match [url: ResolvedModuleUrl]', () => {
+    expectTypeOf<TestSubject>()
+      .toHaveProperty('url')
+      .toEqualTypeOf<ResolvedModuleUrl>()
+  })
+})

src/hooks/index.ts

@@ -11,4 +11,5 @@ export type { default as GetSourceHookContext } from './get-source-context'
 export type { default as GlobalPreloadHook } from './global-preload'
 export type { default as GlobalPreloadHookContext } from './global-preload-context'
 export type { default as ResolveHookContext } from './resolve-context'
+export type { default as ResolveHookResult } from './resolve-result'
 export type { default as SourceHookResult } from './source-result'

src/hooks/resolve-result.ts

@@ -0,0 +1,42 @@
+/**
+ * @file Hooks - ResolveHookResult
+ * @module esm-types/hooks/ResolveHookResult
+ */
+
+import type { Format } from '#src/enums'
+import type { ResolvedModuleUrl } from '#src/types'
+import type { Nilable } from '@flex-development/tutils'
+
+/**
+ * [`resolve`][1] hook result.
+ *
+ * [1]: https://nodejs.org/api/esm.html#resolvespecifier-context-nextresolve
+ */
+interface ResolveHookResult {
+  /**
+   * Module format hint for [`load`][1] hook.
+   *
+   * **Note**: Hint may be ignored.
+   *
+   * [1]: https://nodejs.org/api/esm.html#loadurl-context-nextload
+   *
+   * @see {@linkcode Format}
+   */
+  format?: Nilable<Format>
+
+  /**
+   * Signal that the current hook terminates the chain of `resolve` hooks.
+   *
+   * @default false
+   */
+  shortCircuit?: boolean | undefined
+
+  /**
+   * Resolved module URL.
+   *
+   * @see {@linkcode ResolvedModuleUrl}
+   */
+  url: ResolvedModuleUrl
+}
+
+export type { ResolveHookResult as default }