docs(mime): update readme

thi-ng · Mar 27, 2021 · 4afe0f6 · 4afe0f6
1 parent 88f6165
commit 4afe0f6
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/packages/mime/README.md b/packages/mime/README.md
@@ -46,7 +46,7 @@ yarn add @thi.ng/mime
 <script src="https://unpkg.com/@thi.ng/mime/lib/index.umd.js" crossorigin></script>
 ```
 
-Package sizes (gzipped, pre-treeshake): ESM: 4.46 KB / CJS: 4.52 KB / UMD: 4.63 KB
+Package sizes (gzipped, pre-treeshake): ESM: 4.52 KB / CJS: 4.58 KB / UMD: 4.68 KB
 
 ## Dependencies
 
@@ -91,6 +91,19 @@ preferredType("foo", "text/plain")
 // "text/plain"
 ```
 
+Since v0.3.0 reverse lookups are possible too, using `preferredExtension()` (also supports fallback):
+
+```ts
+preferredExtension("image/svg+xml");
+// "svg"
+
+preferredExtension("image/foo");
+// "bin" (default fallback)
+
+preferredExtension("image/foo", "dat");
+// "dat" (custom fallback)
+```
+
 ## Conversion from mime-db
 
 1. Download the [latest version of mime-db's JSON

diff --git a/packages/mime/tpl.readme.md b/packages/mime/tpl.readme.md
@@ -76,6 +76,19 @@ preferredType("foo", "text/plain")
 // "text/plain"
 ```
 
+Since v0.3.0 reverse lookups are possible too, using `preferredExtension()` (also supports fallback):
+
+```ts
+preferredExtension("image/svg+xml");
+// "svg"
+
+preferredExtension("image/foo");
+// "bin" (default fallback)
+
+preferredExtension("image/foo", "dat");
+// "dat" (custom fallback)
+```
+
 ## Conversion from mime-db
 
 1. Download the [latest version of mime-db's JSON