wardens 0.6.0-rc.3 → 0.6.0-rc.4

package/CHANGELOG.md

@@ -9,6 +9,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ### Added
 
 - New context API carries state down the tree without plumbing through arguments.
+- New `ContextType<Handle>` utility type which gets the value type of a context.
 
 ### Changed
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wardens",
-  "version": "0.6.0-rc.3",
+  "version": "0.6.0-rc.4",
   "description": "A framework for resource management",
   "type": "module",
   "main": "./dist/wardens.cjs",

package/src/__tests__/utility-types.test-d.ts

@@ -1,4 +1,10 @@
-import { create, ResourceScope, ResourceHandle } from '../';
+import {
+  create,
+  ResourceScope,
+  ResourceHandle,
+  createContext,
+  ContextType,
+} from '../';
 
 describe('Utility types', () => {
   describe('ResourceHandle', () => {
@@ -29,4 +35,22 @@ describe('Utility types', () => {
       });
     });
   });
+
+  describe('ContextType', () => {
+    it('returns the type contained in context', async () => {
+      const Context = createContext(() => ({
+        hello: 'world',
+      }));
+
+      async function Test({ getContext }: ResourceScope) {
+        return { value: getContext(Context) };
+      }
+
+      const value = await create(Test);
+
+      expectTypeOf(value).toEqualTypeOf<ContextType<typeof Context>>({
+        hello: 'any string, really',
+      });
+    });
+  });
 });

package/src/index.ts

@@ -1,5 +1,5 @@
 export { default as bindContext } from './bind-context';
 export { createRoot as create, destroyRoot as destroy } from './root-lifecycle';
 export { createContext } from './inherited-context';
-export type { Resource, ResourceHandle } from './utility-types';
+export type { Resource, ResourceHandle, ContextType } from './utility-types';
 export type { default as ResourceScope } from './resource-scope';

package/src/utility-types.ts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
+import type { ContextHandle } from './inherited-context';
 import type ResourceScope from './resource-scope';
 
 /**
@@ -29,3 +30,7 @@ export interface Resource<Value extends object> {
 export type ResourceHandle<
   Factory extends ParametrizedResourceFactory<object, Array<any>>,
 > = Awaited<ReturnType<Factory>>['value'];
+
+/** The type returned when you call `getContext`. */
+export type ContextType<Handle extends ContextHandle<unknown>> =
+  Handle extends ContextHandle<infer Value> ? Value : never;