a-frame-components - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "a-frame-components",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

README.md

@@ -70,3 +70,38 @@ # AFrame Components Repository
 
+## How to Include Type Definitions from a-frame-components in Your TypeScript Project
+### Ensure TypeScript can fully utilize the a-frame-components package's TypeScript type definitions by incorporating them in your compilation configuration. Follow these wholesome configurations to embrace the in-packaged TypeScript types.
 
+1. Get to Know Your tsconfig.json
+The tsconfig.json file is the center-stage of any settings inherent to the cycle and reach of TypeScript within your project. It delivers the capstone instructions to TypeScript's compiler.
+
+2. Aim to include The Paths
+Modulate your tsconfig.json file by sprucing it up with a direction for "the known" TypeScript sources, specifically focusing on the rich types springing from your a-frame-components NPM package.
+
+Construct the tsconfig.json for Enlightenment
+The synthesis of the types from a-frame-components will be perceived if you mark a structured setting like so within your tsconfig.json:
+
+```json
+{
+  "compilerOptions": {
+    //.... 
+  },
+  "include": [
+    "src/**/*",
+    "types/**/*",
+    "node_modules/a-frame-components/types/**/*"
+  ]
+}
+
+```
+
+### Inference
+Why the Emphasis on node_modules/a-frame-components/types/**/*:
+Including the node_modules/a-frame-components/types/**/* in the include array concisely tells TypeScript to calibrate its bearings towards fetching from the in-package-type-definitions. This eases the flow of the right kinds of intrinsics about your components across your codebase.
+
+### Moral Check:
+The enlistment of this action leads to telescopic facilities for code hinting, type verifications, and the very blood flow of guided-coding practices.
+
+### Conclusively
+Your project will sing to the paragons of better structure, dialectic sanity, and order of amplitude if you tow with the very plexus of these vestments.
+
 ## License
@@ -73,0 +108,0 @@

types/aframe.d.ts

@@ -280,3 +280,3 @@ // aframe.d.ts
             color?: string;
-            intensity?: number;
+            intensity?: number | string;
 
@@ -283,0 +283,0 @@ // Spot and Directional Light Exclusive

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1473961

increased by0.13%

Number of lines in readme file

114

increased by44.3%

No dependency changes