Export more types

Author: mb21

deno.lock

@@ -1,5 +1,11 @@
+/**
+ * HTML primitive values like strings and numbers.
+ *
+ * Note that we use [`String` objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)
+ * to store already properly escaped HTML.
+ */
 // deno-lint-ignore ban-types
-type HtmlPrimitive = String | string | number | undefined | null;
+export type HtmlPrimitive = String | string | number | undefined | null;
 
 /**
  * An `Html` node – i.e. what can be used with `html` tagged templates.

src/core/html.ts

@@ -9,7 +9,10 @@
 import { type Html, html, renderToString } from "./core/html.ts";
 import { htmlToResponse } from "./core/responses.ts";
 
-interface AtomFeed {
+/**
+ * An Atom feed with an array of entries.
+ */
+export interface AtomFeed {
   author?: AtomAuthor;
   entries: AtomEntry[];
   /** Link to the feed itself. */

src/feed.ts

@@ -16,8 +16,16 @@ import {
   MagickFormat,
 } from "npm:@imagemagick/[email protected]";
 
+export type ImageFormat = MagickFormat;
+
+/**
+ * Preset to transform an image to the specified format, using a transform function
+ * which gets passed an [IMagickImage](https://github.com/dlemstra/magick-wasm/blob/82a4c4e45d5fda6c88becbaba8340df3f5d30c13/src/magick-image.ts#L81)
+ * on which you can methods like `.resize(64, 64)`;
+ */
 export interface ImagePreset {
-  format?: MagickFormat;
+  /** defaults to WEBP */
+  format?: ImageFormat;
   transform: (image: IMagickImage) => void;
 }
 

src/images.ts

@@ -14,7 +14,10 @@ const importLazy = (pkg: string) =>
 // from https://github.com/dworthen/js-yaml-front-matter/blob/master/src/index.js#L14
 const yamlFrontRe = /^(-{3}(?:\n|\r)([\w\W]+?)(?:\n|\r)-{3})?([\w\W]*)*/;
 
-interface Md {
+/**
+ * Return type containing the generated HTML and the YAML metadata.
+ */
+export interface Md {
   content: Html;
   meta: Record<string, string>;
 }