docs: Add Identifiers Changelog entry

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- feat: Add a full description of `Identifiers` as JSDoc comment.
+  This establishes the definition of what an `Identifiers` is.
+
 
 ### Deprecated
 

src/types/Identifier.ts

@@ -1,11 +1,35 @@
 /**
- * The dependency identifier.
+ * ## The dependency identifier
- * You can use any string as identifier.
+ *
- * To create order, it is also possible to
+ * You can use any string or Symbol as identifier. The identifier is used to
- * provide these with a separator: `GroupA.ClassZ`.
+ * register a class in the TSinjex DI (Dependency Injection) container.
- * The convection for naming is as follows:
+ * See **Hierarchical identifiers** for more information on `.` in identifiers.
- * The name should generally correspond to the interface that is relevant.
+ *
- * I.e. a class `ClassA` that implements the interface `IClassA` and is
+ * ### Hierarchical identifiers
- * registered as a dependent class is registered under the interface name `IClassA`.
+ * To create hierarchical identifiers, you can use a dot `.` as a separator.
+ * E.g. `Parent.Child` or `Parent.Child.Grandchild`.
+ *
+ * ### Merge functionality
+ * You can merge multiple dependencies into one by resolving them with
+ * a identifier that is a prefix of the actual identifiers.
+ * E.g. `Parent` resolves `Parent.*` and returns a mixin of all children.
+ * Merging will only work, if the main identifier is not registered.
+ * Grandchildren are not included in the mixin but you can use something like
+ * `Parent.Child.Grandchild` to merge all direct children of Grandchild,
+ * e.g. `Parent.Child.Grandchild.*`.
+ * If you don't want to allow merging, you must register the dependencies
+ * with the full identifier. E.g. `Parent` or `Parent.Child.Grandchild`.
+ *
+ * ### Naming convention
+ * The name of a dependency should generally correspond to the interface that is implemented.
+ * E.g. a class `ClassA` that implements the interface `IClassA` and is registered
+ * as a dependent class is registered under the interface name `IClassA`.
+ *
+ * The mixin parts of the class are registered under the interface name `IClassA.*`.
+ * E.g. `IClassA.IClassZ`, `IClassA.IClassY`, etc.
+ *
+ * #### Static/Constructor Identifier naming
+ * The identifier for a static or constructor dependency should be the same as the class name
+ * postfixed with `_`. E.g. `IClassA_` for the the static or constructor interface of class `IClassA`.
  */
 export type Identifier = string | symbol;