feat: export Result and ResultConfig types from package entry

README.md

@@ -545,6 +545,24 @@ Do **not** use `Math.random()` in `fontName` — that renames both font files an
 
 `webfont()` resolves to an object with generated font buffers (and optional `template` output). The `config` property contains the **effective options** used for the run (defaults, discovered config, and any options you passed in), plus optional **output metadata** when a configuration file was found or loaded.
 
+#### TypeScript
+
+`Result` and `ResultConfig` are exported from the package entry, so you can annotate `webfont()` output directly instead of relying on `ReturnType` inference:
+
+```ts
+import { webfont, type Result, type ResultConfig } from "webfont";
+
+const result: Result = await webfont({
+  files: "src/svg-icons/**/*.svg",
+});
+
+const config: ResultConfig | undefined = result.config;
+
+if (config?.filePath) {
+  console.log(`Loaded config from ${config.filePath}`);
+}
+```
+
 #### `result.config.filePath`
 
 - Type: `string` | `undefined`

src/index.test.ts

@@ -1,7 +1,17 @@
-import index from ".";
+import index, { type Result, type ResultConfig, webfont } from ".";
 
 describe("index", () => {
   it("should be exported", () => {
     expect(typeof index === "function").toBe(true);
   });
+
+  it("should expose webfont as both the default and a named export", () => {
+    expect(index).toBe(webfont);
+  });
+
+  it("should re-export the public Result and ResultConfig types", () => {
+    expectTypeOf<Result["config"]>().toEqualTypeOf<ResultConfig | undefined>();
+    expectTypeOf<ResultConfig>().toHaveProperty("filePath");
+    expectTypeOf<ResultConfig["filePath"]>().toEqualTypeOf<string | undefined>();
+  });
 });

src/index.ts

@@ -2,5 +2,7 @@ import { webfont } from "./standalone";
 
 export { diagnoseGlyphsData, diagnoseSvgContents } from "./lib/svgDiagnostics/diagnoseSvgContents";
 export { webfont } from "./standalone";
+export type { Result } from "./types/Result";
+export type { ResultConfig } from "./types/ResultConfig";
 export type { SvgDiagnosticCode, SvgGlyphDiagnostic, SvgToolsOptions } from "./types/SvgToolsOptions";
 export default webfont;