chore: add some preliminary doc for resolve

aurelia · Aug 10, 2024 · a77495f · a77495f
1 parent 29804a4
commit a77495f
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/src/container.ts b/src/container.ts
@@ -626,6 +626,20 @@ export type ResolvedValue<T> =
                   ? [ResolvedValue<T1>, ...ResolvedValue<T2>]
                   : T;
 
+/**
+ * Resolve a key, or list of keys based on the current container.
+ * 
+ * @example
+ * ```ts
+ * import { resolve } from 'aurelia-framework';
+ * // or
+ * // import { Container, resolve } from 'aurelia-dependency-injection';
+ * 
+ * class MyCustomElement {
+ *  someService = resolve(MyService);
+ * }
+ * ```
+ */
 export function resolve<K extends any>(key: K): ResolvedValue<K>;
 export function resolve<K extends any[]>(...keys: K): ResolvedValue<K>
 export function resolve<K extends any[]>(...keys: K) {