@dads-framework/pdf 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +32 -1
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -7,7 +7,38 @@ alternate import of the same type.
7
7
  in PDF points for placing bounded text. Its metrics use the same font as rendering.
8
8
  Server processes and local desktop runtimes can both import it. Node
9
9
  only (`node:module`, `node:path`, the native `@napi-rs/canvas`): never import
10
- it from browser code. See `docs/reference/pdf.md`.
10
+ it from browser code.
11
+
12
+ ## Try it
13
+
14
+ In a project using Node.js 22 or later, install the example dependencies.
15
+ Run from a directory where you can write the PDF.
16
+
17
+ ```sh
18
+ npm install @dads-framework/pdf
19
+ npm install -D tsx
20
+ ```
21
+
22
+ Save this as `example.mts` and run `npx tsx example.mts`.
23
+
24
+ <!-- dads:check-example -->
25
+
26
+ ```ts
27
+ import { writeFile } from "node:fs/promises";
28
+ import { createFixedPagePdfRenderer } from "@dads-framework/pdf";
29
+
30
+ const bytes = await createFixedPagePdfRenderer().render({
31
+ width: 300,
32
+ height: 200,
33
+ pages: [["Daily report", "Ready for review"]],
34
+ });
35
+ await writeFile("daily-report.pdf", bytes);
36
+ console.log("Wrote daily-report.pdf");
37
+ ```
38
+
39
+ Open `daily-report.pdf` to see one page with the two lines of text.
40
+
41
+ The starter uses `createPdfRenderer` to generate PDF exports of notes. [`apps/kit-workbench/domains/notes/server/exports.ts`](../../../apps/kit-workbench/domains/notes/server/exports.ts)
11
42
 
12
43
  ## Portable fixed-page output
13
44
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@dads-framework/pdf",
3
- "version": "0.1.0",
3
+ "version": "0.2.0",
4
4
  "type": "module",
5
5
  "engines": {
6
6
  "node": ">=22"