chore: improve comments + types

This commit is contained in:
Ben Schlegel 2024-01-26 20:41:06 +01:00
parent 881eb67988
commit 2a14a898f5
No known key found for this signature in database
GPG Key ID: 8BDB8891C1575E22
3 changed files with 3 additions and 3 deletions

View File

@ -35,7 +35,7 @@ export interface GlobalConfiguration {
*/
baseUrl?: string
/**
* Wether to generate and use social images (Open Graph and Twitter standard) for link previews
* Wether to generate social images (Open Graph and Twitter standard) for link previews
*/
generateSocialImages: boolean | Partial<SocialImageOptions>
theme: Theme

View File

@ -10,7 +10,7 @@ import { JSXInternal } from "preact/src/jsx"
import { unescapeHTML } from "../util/escape"
/**
* Generates social image (OG/twitter standard) and saves it as `.web` inside the public folder
* Generates social image (OG/twitter standard) and saves it as `.webp` inside the public folder
* @param opts options for generating image
*/
async function generateSocialImage(opts: ImageOptions, userOpts: SocialImageOptions) {

View File

@ -2,7 +2,7 @@ import { SatoriOptions } from "satori/wasm"
import { GlobalConfiguration } from "../cfg"
import { SocialImageOptions } from "./imageHelper"
export const defaultImage = (
export const defaultImage: SocialImageOptions["imageStructure"] = (
cfg: GlobalConfiguration,
userOpts: SocialImageOptions,
title: string,