From e5c64f1abff4f278f358d1638f396c76afe9a183 Mon Sep 17 00:00:00 2001 From: Mark Oosting Date: Thu, 4 Jan 2024 12:59:21 +0100 Subject: [PATCH] Updated docs --- README.md | 23 ++- docs/assets/navigation.js | 2 +- docs/assets/search.js | 2 +- docs/classes/Container.html | 33 ++-- docs/classes/ContainerNotResolvedError.html | 4 +- docs/classes/ContainerOverrideUserError.html | 4 +- docs/classes/CyclicalDependencyError.html | 4 +- docs/classes/ExtendableContainer.html | 39 ++-- docs/classes/ParameterNotFoundError.html | 187 +++++++++++++++++++ docs/classes/ServiceNotFoundError.html | 4 +- docs/enums/Lifetime.html | 6 +- docs/functions/assert.html | 2 +- docs/hierarchy.html | 2 +- docs/index.html | 6 +- docs/interfaces/BundleInterface.html | 6 +- docs/modules.html | 5 +- docs/types/BundleConfigType.html | 2 +- docs/types/ClassType.html | 2 +- docs/types/Dependencies.html | 2 +- docs/types/DependsOn.html | 2 +- docs/variables/container-1.html | 2 +- src/ExtendableContainer.ts | 9 + src/types.ts | 20 +- typedoc.json | 2 +- 24 files changed, 291 insertions(+), 79 deletions(-) create mode 100644 docs/classes/ParameterNotFoundError.html diff --git a/README.md b/README.md index 39395b4..7891723 100644 --- a/README.md +++ b/README.md @@ -198,15 +198,15 @@ import type { BundleInterface } from '@wildsea/dependency-injection' /* Define the bundle configuration class */ export class MyBundleConfig { debug: boolean; - graphics: Partial; + myService: Partial; } /* Create the bundle definition */ export class MyBundle implements BundleInterface { constructor( - public timer: Timer, - public graphics: GraphicsManager, + public api: ApiManager, + public service: MyService, ) {} /* The configure() method wires the services in this bundle */ @@ -215,12 +215,15 @@ export class MyBundle implements BundleInterface { /* Apply configuration overrides */ const config = {...new MyBundleConfig(), ...overrides}; - /* Register the services in this bundle */ - container.transient(Timer, []); - container.singleton(GraphicsManager, [Timer, config.graphics]); + /* Get some global parameters (could also be passed via config, based on the scope) */ + const apiKey = container.getParameter('apiKey'); + + /* Wire the services in this bundle */ + container.transient(ApiManager, [apiKey]); + container.singleton(MyService, [ApiManager, config.myService]); /* Then register the bundle itself */ - container.register(MyBundle, [Timer, GraphicsManager]); + container.register(MyBundle, [Timer, MyService]); } } ``` @@ -254,14 +257,14 @@ container.addExtension(MyBundle, { ```ts import { MyBundle } from "." -/* You must call `build` first. This will wire the services. */ +/* You must call `build` first. */ container.build(); const ext = container.getExtension(MyBundle); if (ext) { - const bundleTimer = ext.timer; /* instanceof 'Timer' */ - const bundleGraphics = ext.graphics; /* instanceof 'GraphicsManager' */ + const instance1 = ext.api; /* instanceof 'ApiManager' */ + const instance2 = ext.service; /* instanceof 'MyService' */ } ``` diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js index 55d2b04..b20e251 100644 --- a/docs/assets/navigation.js +++ b/docs/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42Ty27CMBBF/8Vr2pS0UJplKZUqVUXqY4VYuM6kGdVxkD1EoIp/rwHhvJzA0r53zh3N2Is/RrAhFrFproijAs0GTKQoYw2KRQuvvuKU2ishuTFgAiddp5RJq/+iilk0DCe7gaufbQhUzL8l9JA8pj6maJMKrnFfbwInXg3rjNuwgnjFBAgzKAmg1pkJTvf10sluWal9XKvYJnUM7Ki+KAKdcFEJwNOVCRqeelg4GrfC7FgS/Pncrio8sqcTqtQbrJuH++EorLU/p7Rz2/t1aCozkrUShLkywVGp08d3Fex0v0tfh07wt1YSnmBlX4GZqybBCZcRQAk8rMcDOWrnhzTTOtddK55uhUTBpUNuD3bPD/Eb+962+wBvOb2DyWUBcRe9y3oRf16A1hjDl93ruYCWty/hA3SBAmxTz7l9nB1sn6tNXe6W/wHYYnSrBAAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA42TXU/CMBSG/4rpNTqZgsiliImJEePHFeGidmfuxK4j7WGBGP67hYXug25w2fO+fd6253T+xwjWxMZskiniqECzHhMJykiDYuO5V19ySmxJSG4MmMBJVwml0uq/qCI27oejbc/tn64JVMS/JXSQPKYupjgm5Vzjbr8JnHjZrzNuwgriBWMgTKEkgFqlJjjU61tH20XzSgYzdfGwUpHNbHm6Qn1WBDrmohKFh5IJGp56bDgYVmILq32gGH8+N8sKj+zqgCr1Buv6/q4/CGsXmVHS2vddYzSVGfFKCbJ3NkGh1OnD2wp2suuq74RO8B+tJDzC0s6DmakmwQnnEUAJ3LfHAym004801TrTbS2ebIREwaVDbvZ2z1/xG7um3H2F14zewWQyh6iN3mY9iz/LQWuM4Mv29VTAkbcr4Y1rngLtj/WU2fFsoft9XeQP0DkKOMH1uY6pi+3iH+J/+CoPBQAA" \ No newline at end of file diff --git a/docs/assets/search.js b/docs/assets/search.js index 238ec20..a56c584 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7Va227bRhD9lYJ+VWztLqmL39LERQO0SZGkfTEMgxHXDlGKEkjKTWD437vL285QMySlMG+hdeayc2aGM9w8e9nuv9y7vn32/o3TyLtWcual4VZ7195mlxZhnOrMm3mHLDF/eQqzOPyS6Pyq/e2VuPxabBMD2SRhnmujy/NeZo06IVetvjdH+mqRq/aXXl2BQL7lRXbYFLshbRcYCjTPvH2Y6bRArgHX59Jv7Rmk+Uehs3zIHEI6a0UevYrzV/tsV+hNoaOTrEd6r9NIp5tYD9rvYCfyINfZU7wZtg5wE1nePeksjoYtA9xElpvD/BE/6CLeDrtwTwgQvsRPYaFP82Sz2+7jpPS/3wMAPNeynPsrwHvxV5PQw9wj7PhKQxYfT7D4OInFTD/G+QhrAHempTxOHxNd7NLBUALgmbaKLEzz2IIHbEHgmba+HOJkMDcb0Jk2bH3bAh/TB2rc+Rk4IvF+JN/yXfI0eBAHO9POJtOm3N+Zt1+YbgbNHaHP7lzglX/zrTAvIzsy8C9/AjPJGMDpZQeC+phx+tW8STovC+ogTLPWFprHxsh4l5DMuNfXOR4Z5EP8eIZbreDkvlkbn7/v9Z/hfrxf90hoTKL2e4TKJoyim+bc413qSNEle4IXpsOc4UVH6oe9oBs7a76/xZ+QFT3jNmt85OD9y0Rl3juTs06Ons6ncpMd3FkXR43wU7nHTvese6Pm/KncG14B+B51wjIwmbvsnsC7OWJj+AH3xi8TPfnIDPkTedW7cPR12p/qFbuUsB6R68lUzLGLC08bucJM5A+/3LD+0GvORP6wy0lvGztaU6bL6JMS+efkL73k9KTv8bpzvi/Okab/tp7o9LDNr5o/93+9XLRqPv3++uPN2z4lFy2EHn9aR0j9nz++fv/p3c37z70mIGq0FTlfL0XglqY3VtCOz62pwjyYhbD5e29MFkGgnNv398WQoosWw+yxrTu8y2/LsSn/kHYstX/vdZnW1hndoMLqp36dgQvCr4c0SszqbJrvQwg27bj5S37VgQy4C5f4cvM6ZKO1XkAJOuJdf/lIVchq+yMypvtzf+K4OcX+mrke9XBIN4Vdfq+qH8bfKHzfJPEmTFrWvt9kGXUjQONOv7l4vys+Vn0qYixxyNNtfajfEH+bkAwYO4KOtvapGlKNt7/tDJm0HQpEWbibmeSM9Dfv+tkzHpVL6LUnL9Xl2iAfYp1E9qqpsm1Ed9utTci7+rd/tP0kYxEV5GruzW7nMyUu5WJ1dze7bSTKH8o/lDDBwQSCSfMkKJhEMGWeJAVTCOabJzWTy8v1XCGYj2CBefIpbQGCLcxTQMEWCLY0TwsKtkSwlXlaUrAVghlSblcUbI3Da6O9JuPb4cHGW9BMYCpEyQVJhsBsCBt1IalAC0yIsIEXitSJORE29oJkRWBahA2/IIkRmBlhGRAkNwKTIywJwtCzuFTLBUZifoTlQaxIJKZIztncxhTJkqI1pVJ2qsXyIOckElMky4oRJBJTJC0PUpJITJG0PEhFIjFFcsHSLjFFcslVtsQMyRVX2xITJNdcdUvMj5pz9a0wP0pwFa4wPUpyNa467UxxVa4wOcrnylxhblTAlrnC3KgFW+YKc6OWbJkrTI5ascWrMDtqzRavwvT4c7Z4fcyPb1mQPpWXPibIL+snIJGYIZ9vcX7nnVPWz4LUiTnyy/ohm4yPOfItEZJsMj7myF+yrzxMkW95kGST8TFFvuVBkU3GxxQFlgdFNpkAUxRYHhTZZAJMUWB5UGSTCTBFgeVBkbQHmKKgnAtI2oPOZGB5UCSZQUVROU6ZOcosvu+qscoMRs0y9ezd17OWobme5p49Q+7188uLm63sk1UdRpF2FwNAWDph04MZ4Xpcd2IKiJmo0mL1bYCTMm26lRKlsZlnmjQnbXeLapnpHtkkgjM/71UQu60MnHoNQrZi5MvJ9ijYCyDJxct9UnWCgKRVdXLTqDnxdoEDR54Dw2te0t1sgrgDjuuoc0ED/+fLyQPT80qeo7wVT3dF/UEn0tVOAY7iA/bUkKbmQ9nB5OCxqgCoYukob7bj9mYbBAawItg8qJfH9urm+7EbILEDjlZ89QOEAbE1O3WGmL7apyrvlPIKKOKqSrdfzUimBdAhuCxrG8mmvhUGPoBUkVwg4GU3MA1qUnL5ZURtRW7tvS+wChOcS6jyOycwBzJHLOqK5E5sZOnuCbiTXOs1wnt3U+CEwXlFXVaKS+Gk/YgJjIMy8rmAudsyJwhO3hycawfuKzWIHLArgloBVzzwUha47jSoOuW5VHe3GsADkGVC1B5w4W+/KwN50MTFsq41LgT1NV7irvGcIqCnVqM4Imo1pi8+2G8oxy0E6Aq4s7irWScIm2kdSy6NcyYTQdGv62NwVZR/DTP8YpMgnXyu5MFlEKABlK2oX0yKa1zg+gZoAIkk6kxSDaHkEcxMtY/3hs3UCN3evbz8D/gltbgBLQAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7Va227bRhD9lYJ+VWztLlcXv6WJiwZokyJJ+2IYBiPSDlGKEkjKTWD437vL285QMySlMG+hdeayc2aGM9w8e9nuv9y7vn32/o3T0LtWcualwTbyrr3NLi2COI0yb+YdssT85SnI4uBLEuVX7W+vxOXXYpsYyCYJ8jwyujzvZdaoE3LV6ntzpK8WuWp/6dWlBfItL7LDptgNabvAUKB55u2DLEoL5BpwfS791p5Bmn8UUZYPmUNIZ63Iw1dx/mqf7YpoU0ThSdbDaB+lYZRu4mjQfgc7kQd5lD3Fm2HrADeR5d1TlMXhsGWAm8hyc5g/4oeoiLfDLtwTAoQv8VNQRKd5stlt93FS+t/vAQCea1nO/RXgvfirSehh7hF2fKUhi48nWHycxGIWPcb5CGsAd6alPE4fk6jYpYOhBMAzbRVZkOaxBQ/YgsAzbX05xMlgbjagM23Y+rYFPqYP1LjzM3BE4v1IvuW75GnwIA52pp1NFplyf2fefkG6GTR3hD67c4FX/s23wryM7MjAv/wJzCRjAKeXHQjqY8bpV/Mm6bwsqIMwzTqy0Dw2Rsa7hGTGvb7O8cggH+LHM9xqBSf3zdr4/H0f/Rnsx/t1j4TGJGq/R6hsgjC8ac493qWOFF2yJ3hhOswZXnSkftgLurGz5vtb/AlZ0TNus8ZHDt6/TFTmvTM56+To6XwqN9nBnXVx1Ag/lXvsdM+6N2rOn8q94RWA71EnLAOTucvuCbybIzaGH3Bv/DLRk4/MkD+RV70LR1+n/alesUsJ6xG5nkzFHLu48LSRK8xE/vDLDesPveZM5A+7nPS2saM1ZbqMPimRf07+0ktOT/oerzvn++Icafpv60mUHrb5VfPn/q+Xi1bNp99ff7x526fkooXQ40/rCKn/88fX7z+9u3n/udcERI22IufrpdBuaXpjBe343JoqzINZCJu/98ZkobVybt/fF0OKLloMs8e27vAuvy3HpvxD2rHU/r3XZVpbZ3SDCquf+nVqF4RfD2mYmNXZNN+HAGzacfOX/KoDGXAXLvHl5nXIRmu9gBJ0xLv+8pGqkNX2R2RM9+f+xHFziv01cz3q4ZBuCrv8XlU/jL9R+L5J4k2QtKx9v8ky6kaAxp1+c/F+V3ys+lTIWOKQp9v6UL8h/jYhGTB2BB1trZ1hjL+/7QydtCUaNtrKp2oU7rdBgSgLdzNTAmH0zbt+9sy5y1X32pOX6nJtkA9xlIT2QquybUR3261N+7v6t38i++HHIirI1dyb3c5nSlz6vry7m902EuUP5R9KmOBgAsGkeRIUTCKYMk+SgikE882TmsnV5Xy5RDAfwbR58iltGsEW5klTsAWCLc3TgoItEWxlnpYUbIVghpTbFQVb4/DaaK/J+HZ4sPEWNBOYClFyQZIhMBvCRl1IKtACEyJs4IUidWJOhI29IFkRmBZhwy9IYgRmRlgGBMmNwOQIS4Iw9CwutcZATI+wNIgVBcQEyTmb2ZggWRK0JjTKTqlYEuScAmJ6ZFktggJidqSlQEoKiMmRlgGpKCDmRi5YviXmRi65kpaYGrniilpiauSaK2uJqVFzrrAVpkYJrrQVpkZJrrhVp48prrwVpkb5XH0rTI3SbH0rzI1asPWtMDdqyda3wuSoFVu1CrOj1mzVKkyPP2er1sf8+JYF6RNp6WN+/LJ0NAXE/Ph8Z/M7r5qydhaUSkyQX9YO1Vp8zI9vSZBUa/ExPf6Sfc1hdnxLgaRai4/J8S0DimotPuZGWwIU1Vo0pkZbAhTVWjSmRlsCFNVaNKZG2/grimyNmdHlFECRrTtjgI2/oijUmBlt468oCnXFTDljmeHK7NzvqlnLTEvNHvfs3dcDmMmCesR79gz5188vL27gsk9WdRCGkbuTAMLSCZv2zAjXm4ITU0DMhJ4Wqy8inJRp4a2UKI3NPNPAOWm71lR7VPfIJlec+XmvgtgthODUaxCyFSNfjrtHwV4ASS5e7muuEwQkraqTmybOibe7IzjyHBhe85LuUhXEHXBcR50LGvjvZk4emJ5X8hzlrXi6K+pvSWFULRrgKD5gTw1par7RHUwOHqvSQBVLR3mpHreX6iAwgBXB5kG9t7a3Rt+P3QCJrTla8a0TEAbE1uzUGWIab5+qvFPKK6CIq6qo/WBHMi2ADsFlWdtINvWFNPABpIrkAgHv2YFpUJOSyy8jaitya6+cgVWY4FxClZ9YgTmQOWJRVyR3YiNLd0/AneRarxHeu0sKJwzOK+qyUlwKJ+33U2AclJHPBcxd1DlBcPLm4Fw7cB/IQeSAXaFrBVzxtCc3DeHBflE4rh3QUTUXQ3itDCLgJFVdOVzFuHsZcBCQrELUB+E8aL+MA3nguVjWJctFsr6ITNxFpFME9NRqFMdnrYaPJuhommsC7nLZCcKeXMeSq4acSWjQO9b1MbhizL8GGX4/SpCVPtc5wHUWoAFUv6jfb4o7OriAAhpAIok6k1RDKHkEM5rt471hMzVCt3cvL/8DFV0J6cMtAAA="; \ No newline at end of file diff --git a/docs/classes/Container.html b/docs/classes/Container.html index 40e2fd8..e860395 100644 --- a/docs/classes/Container.html +++ b/docs/classes/Container.html @@ -162,7 +162,7 @@

Other DI solutions use decorators (which are experimental) or reflect-metadata (extra package). This package heavily relies on Typescript and native Javascript features instead.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

parameters dependencies services @@ -181,38 +181,39 @@ createInstance

Constructors

constructor

Properties

Protected parameters

parameters: Record<string, any> = {}

Protected dependencies

dependencies: Map<ClassType<any>, ClassType<any>[]> = ...

Protected services

services: Map<ClassType<any>, any> = ...

Protected overides

overides: Map<ClassType<any>, ClassType<any>> = ...

Private #serviceLifetimes

#serviceLifetimes: Map<ClassType<any>, Lifetime> = ...

Private #compiled

#compiled: boolean = false

Methods

setParameter

  • setParameter(key, value): this

  • Set a 'superglobal'. Can be useful for general application config.

    -

    Parameters

    • key: string
    • value: any

    Returns this

getParameter

  • getParameter<T>(key): T

  • Get a 'superglobal'. Can be useful for general application config.

    -

    Type Parameters

    • T = any

    Parameters

    • key: string

    Returns T

register

Properties

Protected parameters

parameters: Record<string, any> = {}

Protected dependencies

dependencies: Map<ClassType<any>, ClassType<any>[]> = ...

Protected services

services: Map<ClassType<any>, any> = ...

Protected overides

overides: Map<ClassType<any>, ClassType<any>> = ...

Private #serviceLifetimes

#serviceLifetimes: Map<ClassType<any>, Lifetime> = ...

Private #compiled

#compiled: boolean = false

Methods

setParameter

  • setParameter(key, value): this

  • Set a 'superglobal'. Can be useful for general application config.

    +

    Parameters

    • key: string
    • value: any

    Returns this

getParameter

  • getParameter<T>(key, strict?): T

  • Get a 'superglobal'. Can be useful for general application config.

    +

    Type Parameters

    • T = any

    Parameters

    Returns T

register

  • register<T>(ctor, dependencies, lifetime?): this

  • Registers a class as a service.

    Type Parameters

    Parameters

    • ctor: T

      The service to register - can be any class.

    • dependencies: MapDependencies<ConstructorParameters<T>>

      Dependencies (constructor parameters) of the service

    • Optional lifetime: Lifetime = Lifetime.SHARED

    Returns this

    Example

    container.register(LoggerService, [config.logLevel]);
    container.register(Database, [LoggerService]);
    -

singleton

singleton

  • singleton<T>(ctor, dependencies): this

  • Shortcut for register with Lifetime.SHARED.

    Registers a class as a singleton service.

    Type Parameters

    Parameters

    • ctor: T

      The service to register - can be any class.

    • dependencies: MapDependencies<ConstructorParameters<T>>

      Dependencies (constructor parameters) of the service

      -

    Returns this

transient

Returns this

transient

  • transient<T>(ctor, dependencies): this

  • Shortcut for register with Lifetime.TRANSIENT.

    Registers a class as a transient service.

    Type Parameters

    Parameters

    • ctor: T

      The service to register - can be any class.

    • dependencies: MapDependencies<ConstructorParameters<T>>

      Dependencies (constructor parameters) of the service

      -

    Returns this

build

  • build(): this

  • Resolves the container.

    +

Returns this

build

  • build(): this

  • Resolves the container.

    Also applies implementation overrides that were set via override.

    -

    Returns this

override

  • override<T>(ctor, overrideCtor, dependencies?): this

  • Overrides a service with another concrete implementation.

    -

    You may omit the 'dependencies' argument to match the -constructor signature of the overridden class.

    -

    Type Parameters

    Parameters

    • ctor: T
    • overrideCtor: T
    • Optional dependencies: MapDependencies<ConstructorParameters<T>>

    Returns this

    Example

    container.transient(Foo, []); // Foo is some service
    container.singleton(MyService, [Foo]); // MyService depends on Foo

    container.transient(OverrideFoo, []); // Add an override service
    container.override(Foo, OverrideFoo); // MyService will now use OverrideFoo
+

    Returns this

override

  • override<T>(ctor, overrideCtor, dependencies?): this

  • Overrides a service with another concrete implementation.

    +

    You may omit the 'dependencies' argument to match the constructor +signature of the overridden class.

    +

    Type Parameters

    Parameters

    • ctor: T
    • overrideCtor: T
    • Optional dependencies: MapDependencies<ConstructorParameters<T>>

    Returns this

    Example

    class IFoo {
        someMethod(): void {}
    }

    // First register the default implementation / 'base class' for IFoo.
    container.transient(IFoo, []); 

    container.singleton(MyService, [IFoo]); // MyService depends on IFoo

    container.transient(ConcreteFoo, []);   // Register an override service
    container.override(IFoo, ConcreteFoo);  // ConcreteFoo will be passed to MyService
    -

get

  • get<T>(ctor): T

  • Retrieves a service from the container with resolved dependencies.

    +

get

resolve

  • resolve<T>(ctor, strict?): undefined | T

  • Resolves an instance of the given class.

    +

resolve

  • resolve<T>(ctor, strict?): undefined | T

  • Resolves an instance of the given class.

    Type Parameters

    • T

    Parameters

    Returns undefined | T

Private createInstance

  • createInstance<T>(ctor): T

  • Creates a new instance of a service and resolves/injects it's dependencies.

    -

    Type Parameters

    • T

    Parameters

    Returns T

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class ContainerNotResolvedError

Thrown when a user tries to get() an instance from the container, before calling build().

-

Hierarchy

  • Error
    • ContainerNotResolvedError

Properties

prepareStackTrace? +

Hierarchy

  • Error
    • ContainerNotResolvedError

Properties

prepareStackTrace? stackTraceLimit cause? name @@ -170,7 +170,7 @@

Parameters

  • err: Error
  • stackTraces: CallSite[]

Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Optional cause

cause?: unknown

name

name: string

message

message: string

Optional stack

stack?: string

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class ContainerOverrideUserError

Thrown a user tries to override() a class when build() was already called.

-

Hierarchy

  • Error
    • ContainerOverrideUserError

Properties

prepareStackTrace? +

Hierarchy

  • Error
    • ContainerOverrideUserError

Properties

prepareStackTrace? stackTraceLimit cause? name @@ -169,7 +169,7 @@

Parameters

  • err: Error
  • stackTraces: CallSite[]

Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Optional cause

cause?: unknown

name

name: string

message

message: string

Optional stack

stack?: string

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class CyclicalDependencyError

Thrown when a class references itself as a dependency - prevents infinite loops.

-

Hierarchy

  • Error
    • CyclicalDependencyError

Properties

prepareStackTrace? +

Hierarchy

  • Error
    • CyclicalDependencyError

Properties

prepareStackTrace? stackTraceLimit cause? name @@ -170,7 +170,7 @@

Parameters

  • err: Error
  • stackTraces: CallSite[]

Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Optional cause

cause?: unknown

name

name: string

message

message: string

Optional stack

stack?: string

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

Class ParameterNotFoundError

Thrown when a parameter is not found.

+

Hierarchy

  • Error
    • ParameterNotFoundError

Properties

prepareStackTrace? +stackTraceLimit +cause? +name +message +stack? +

Methods

captureStackTrace +

Properties

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

+

Type declaration

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

+

Static stackTraceLimit

stackTraceLimit: number

Optional cause

cause?: unknown

name

name: string

message

message: string

Optional stack

stack?: string

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    +

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/ServiceNotFoundError.html b/docs/classes/ServiceNotFoundError.html index 5ef1567..cd2742b 100644 --- a/docs/classes/ServiceNotFoundError.html +++ b/docs/classes/ServiceNotFoundError.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e1e3e3 }

Class ServiceNotFoundError

Thrown when a service is not found by the container.

-

Hierarchy

  • Error
    • ServiceNotFoundError

Properties

prepareStackTrace? +

Hierarchy

  • Error
    • ServiceNotFoundError

Properties

prepareStackTrace? stackTraceLimit cause? name @@ -169,7 +169,7 @@

Parameters

  • err: Error
  • stackTraces: CallSite[]

Returns any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Static stackTraceLimit

stackTraceLimit: number

Optional cause

cause?: unknown

name

name: string

message

message: string

Optional stack

stack?: string

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

@wildsea/dependency-injection

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

@wildsea/dependency-injection

Class Hierarchy

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias BundleConfigType<T>

BundleConfigType<T>: T extends BundleInterface<infer X>
    ? X
    : never

Provides type hints for a given BundleInterface.

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias ClassType<T>

ClassType<T>: (new (...args) => T)

The static 'name' of a class, rather than an instance. E.g. MyClass instead of new MyClass().

Type Parameters

  • T

    Any constructable class.

    -

Type declaration

    • new (...args): T

    • Parameters

      • Rest ...args: any[]

      Returns T

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias Dependencies<T>

Dependencies<T>: MapDependencies<ConstructorParameters<T>>

Get the dependency types of a class, based on it's ConstructorParameters.

Type Parameters

Settings

Member Visibility

Theme

Generated using TypeDoc

Type alias DependsOn<T>

DependsOn<T>: T | ClassType<T>

A 'nice to read' alias for the depenency mapping. Can be T or the ClassType of T.

Type Parameters

  • T

    Any constructable class.

    -

Settings

Member Visibility

Theme

Generated using TypeDoc