add types

korywka · Sep 2, 2023 · d4645bd · d4645bd
1 parent 05d800a
commit d4645bd
Show file tree

Hide file tree

Showing 6 changed files with 213 additions and 176 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -1,8 +1,9 @@
 {
-	"extends": [
-		"eslint-config-ecmascript"
-	],
-	"ignorePatterns": [
-		"test"
-	]
-}
+  "extends": [
+    "eslint-config-ecmascript"
+  ],
+  "ignorePatterns": [
+    "test",
+    "*.d.ts"
+  ]
+}
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,2 @@
 node_modules
-.idea
-.DS_Store
+.DS_Store
diff --git a/README.md b/README.md
@@ -40,7 +40,12 @@ export default {
   },
   plugins: [
     svg({
-      stringify: true // Optional: returns SVG as a string instead of DOM node
+     /**
+      * If `true`, instructs the plugin to import an SVG as string.
+      * For example, for Server Side Rendering.
+      * Otherwise, the plugin imports SVG as DOM node.
+      */
+      stringify: true
     }),
   ],
 };