@mstream/di - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

.eslintrc.json

@@ -7,2 +7,3 @@ {
   },
+  "ignorePatterns": ["CHANGELOG.md"],
   "parserOptions": {
@@ -9,0 +10,0 @@ "ecmaVersion": 2021,

CHANGELOG.md

@@ -5,2 +5,4 @@ # Changelog
 
+### 2.0.1 (2023-01-18)
+
 ## 2.0.0 (2023-01-18)
@@ -7,0 +9,0 @@

package.json

 {
   "name": "@mstream/di",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "",
@@ -9,2 +9,6 @@ "private": false,
   "scripts": {
+    "format:docs": "prettier --write docs",
+    "format": "npm run format:docs",
+    "generate:docs": "rm -f docs/REFERENCE.md && jsdoc2md src/index.js > docs/REFERENCE.md && npm run format:docs",
+    "generate": "npm run generate:docs",
     "lint:commits": "commitlint --to HEAD",
@@ -36,3 +40,4 @@ "lint:example": "cd example && npm run lint",
     "eslint": "^8",
-    "eslint-config-prettier": "^8.6.0",
+    "eslint-config-prettier": "^8",
+    "jsdoc-to-markdown": "^8",
     "markdown-link-check": "^3",
@@ -39,0 +44,0 @@ "prettier": "^2",

README.md

@@ -5,2 +5,6 @@ # DI
 
+## Documentation
+
+- [reference](docs/REFERENCE.md)
+
 ## Usage Examples
@@ -7,0 +11,0 @@

src/index.js

@@ -0,1 +1,35 @@
+/**
+ * @module
+ */
+
+/**
+ * @typedef {function} BuildFn
+ * @returns {object}
+ */
+
+/**
+ * @typedef {function} RegisterFn
+ * @param {string} name
+ * @param {function} creator
+ * @returns {ContextBuilder}
+ */
+
+/**
+ * @typedef {function} RegisterEagerFn
+ * @param {string} name
+ * @param {function} creator
+ * @returns {ContextBuilder}
+ */
+
+/**
+ * @typedef {object} ContextBuilder
+ * @property {BuildFn} build - builds a context with registered dependencies inside it
+ * @property {RegisterFn} register - register a depenency
+ * @property {RegisterEagerFn} registerEager - registers an eager dependency
+ */
+
+/** Creates a builder which allow to register
+ * dependency creators.
+ * @returns {ContextBuilder}
+ */
 export function contextBuilder() {
@@ -46,3 +80,7 @@ let wasBuilt = false
 
-  return { build, register, registerEager }
+  return {
+    build,
+    register,
+    registerEager,
+  }
 }

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

178321

increased by2.18%

Number of package files

21

increased by16.67%

Lines of code

4700

increased by0.73%

Number of lines in readme file

13

increased by44.44%

Worsened metrics

Dev dependency count

10

increased by11.11%

No dependency changes