Merge pull request #9 from oshx/update/svg

Added the SVG format. Updated README.md for setting. Updated the package version.
oshx · Aug 28, 2024 · 603aed2 · 603aed2
2 parents 59d3525 + 889305a
commit 603aed2
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,8 @@ Please add below in `tsconfig.json` file.
 {
   "compilerOptions": {
     "typeRoots": [
-      "node_modules/@oshx"
+      "node_modules/@oshx",
+      "node_modules/@types"
     ]
   }
 }
@@ -24,7 +25,8 @@ If your TypeScript doesn't accept that type, then add below.
 {
   "compilerOptions": {
     "typeRoots": [
-      "node_modules/@oshx/type-helper"
+      "node_modules/@oshx/type-helper",
+      "node_modules/@types"
     ]
   }
 }
@@ -53,7 +55,7 @@ type AnyFunction
 ```
 
 ```typescript
-// images like GIF, JPG, JPEG, PNG, BMP, WEBP as string module
+// images like GIF, JPG, JPEG, PNG, BMP, WEBP and SVG as string module
 ```
 
 ## Why it comes for?

diff --git a/index.d.ts b/index.d.ts
@@ -98,4 +98,13 @@ declare module '*.bmp' {
  */
 declare module '*.webp' {
   export default string
+}
+
+/** Image File Format SVG
+ *
+ * @example
+ * import example from '~/statics/example.svg';
+ */
+declare module '*.svg' {
+  export default string
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@oshx/type-helper",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Types help TypeScript types.",
   "repository": {
     "type": "git",