Refer

The Refer package provides a set of classes and interfaces that allows you to create, manage and resolve component dependencies that can be passed to other components to establish relationships between them.

Interfaces

IReferenceable

Sets references to dependent components.

IReferences

Interface for a map that holds component references and passes them to components to establish dependencies with each other. Together with the IReferenceable and IUnreferenceable interfaces, it implements a Locator pattern that is used by the PipServices toolkit for Inversion of Control to assign external dependencies to components.

IUnreferenceable

Interface for components that require explicit clearing of references to dependent components.


Classes

DependencyResolver

Helper class for resolving component dependencies. The resolver is configured to resolve named dependencies by a specified locator. During deployment the dependency locator can be changed.

Descriptor

Locator type that is most often used in the PipServices toolkit. It locates components using several fields:

  • Group: package or named group of components like “pip-services”
  • Type: logical component type that defines it’s contract. like “persistence”
  • Kind: physical implementation type, like “mongodb”.
  • Name: unique component name, like “default”
  • Version: version of the component contract like “1.0”

Reference

Contains a reference to a component and locator to find it. It is used by References to store registered component references.

ReferenceException

Error when required component dependency cannot be found.

Referencer

Helper class that sets and unsets references to components.

References

The most basic implementation of IReferences to store and locate component references.