From 422f1b6f5effd945f9d94ab1237a466b66a3950b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Jasikowski?= Date: Thu, 26 Sep 2024 14:38:03 +0200 Subject: [PATCH] Added additional comments to mediaAttributeCachingFn and mediaAttributeCache --- lib/ExpensiMark.ts | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/lib/ExpensiMark.ts b/lib/ExpensiMark.ts index 680119cc..6ab7a7e5 100644 --- a/lib/ExpensiMark.ts +++ b/lib/ExpensiMark.ts @@ -19,7 +19,15 @@ type Extras = { * @deprecated Replaced with mediaAttributeCache */ videoAttributeCache?: Record; + /** + * Function used to cache HTML tag attributes during conversion to and from Markdown + * @param mediaSource URI to media source + * @param attrs Additional attributes to be cached + */ mediaAttributeCachingFn?: (mediaSource: string, attrs: string) => void; + /** + * Key/value cache for HTML tag attributes, where the key is media source URI, value is cached attributes + */ mediaAttributeCache?: Record; }; const EXTRAS_DEFAULT = {};