doc: Update README.md

jaywcjlove · Sep 28, 2023 · 05867cc · 05867cc
1 parent 108fd4f
commit 05867cc
Showing 1 changed file with 22 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,28 @@ const avatar = await image2uri('https://avatars.githubusercontent.com/u/1680273?
 // /9j/2wCEAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDc
 ```
 
+### API
+
+```ts
+export declare const validUrl: (url: string) => boolean;
+export declare const extTypeMap: {
+    '.png': string;
+    '.apng': string;
+    '.gif': string;
+    '.jpg': string;
+    '.jpeg': string;
+    '.bm': string;
+    '.bmp': string;
+    '.webp': string;
+    '.ico': string;
+    '.svg': string;
+};
+export type ExtType = keyof typeof extTypeMap;
+export default function image2uri(file: string, options?: {
+    ext?: string;
+}): string | Promise<string>;
+```
+
 ### Development
 
 ```bash