feat: create AvaContext to augument by library user

avajs · Dec 24, 2024 · b88bc3d · b88bc3d
1 parent 024de32
commit b88bc3d
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/recipes/typescript.md b/docs/recipes/typescript.md
@@ -151,6 +151,20 @@ test('an actual test', t => {
 });
 ```
 
+Alternatively, you can extend the type globally:
+
+```ts
+declare module 'ava' {
+    interface AvaContext {
+        foo: string;
+    }
+}
+
+test.beforeEach(t => {
+	t.context = {foo: 'bar'};
+});
+```
+
 Note that, despite the type cast above, when executing `t.context` is an empty object unless it's assigned.
 
 ## Typing `throws` assertions

diff --git a/types/test-fn.d.cts b/types/test-fn.d.cts
@@ -72,7 +72,9 @@ export type Macro<Args extends unknown[], Context = unknown> = {
 /** A test or hook implementation. */
 export type Implementation<Args extends unknown[], Context = unknown> = ImplementationFn<Args, Context> | Macro<Args, Context>;
 
-export type TestFn<Context = unknown> = {
+interface AvaContext {}
+
+export type TestFn<Context = AvaContext> = {
 	/** Declare a concurrent test. Additional arguments are passed to the implementation or macro. */
 	<Args extends unknown[]>(title: string, implementation: Implementation<Args, Context>, ...args: Args): void;