diff --git a/README.md b/README.md index 63f3e6e..c488879 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ yarn add cdktf-injector - ### [Necessity](markdown/necessity.md) - ### [Examples](markdown/examples.md) -- ### [Cross-Stack References](mardkwon/cross-stack-references.md) +- ### [Cross-Stack References](markdown/cross-stack-references.md) - ### [Dependency Issues](markdown/dependency-issues.md) - ### [API](https://apexcaptain.github.io/cdktf-injector/) diff --git a/docs/classes/TerraformInjectorStack.html b/docs/classes/TerraformInjectorStack.html index 377ffe1..aa0edd1 100644 --- a/docs/classes/TerraformInjectorStack.html +++ b/docs/classes/TerraformInjectorStack.html @@ -1,7 +1,7 @@ TerraformInjectorStack | cdktf-injector
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TerraformInjectorStack

Stack class extends TerraformStack and implementing TerraformInjector.

see

https://www.terraform.io/cdktf/concepts/stacks

-

Hierarchy

  • TerraformStack
    • TerraformInjectorStack

Implements

Index

Constructors

Properties

Constructors

  • new TerraformInjectorStack(scope: Construct, name: string, injectorDescription?: string): TerraformInjectorStack

Properties

backend: <TerraformBackendType, PropsType, SharedType>(terraformBackendClass: TerraformInjectorBackendClassType<TerraformBackendType, PropsType>, configure: TerraformInjectorConfigureCallbackType<PropsType, SharedType>, description?: string) => TerraformInjectorElementContainer<TerraformBackendType, SharedType>

Type declaration

Hierarchy

  • TerraformStack
    • TerraformInjectorStack

Implements

Index

Constructors

Properties

Constructors

  • new TerraformInjectorStack(scope: Construct, name: string, injectorDescription?: string): TerraformInjectorStack

Properties

backend: <TerraformBackendType, PropsType, SharedType>(terraformBackendClass: TerraformInjectorBackendClassType<TerraformBackendType, PropsType>, configure: TerraformInjectorConfigureCallbackType<PropsType, SharedType>, description?: string) => TerraformInjectorElementContainer<TerraformBackendType, SharedType>

Type declaration

  • Optional description: string

    Optional description string.

    -
  • Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>

    inject: () => void

    Type declaration

    inject: () => void

    Type declaration

      • (): void
      • Commit dependency injection for all the elements below the scope level.

        -

        Returns void

    provide: <TerraformElementType, ConfigType, SharedType>(terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>, id: string, configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType>, description?: string) => TerraformInjectorElementContainer<TerraformElementType, SharedType>

    Type declaration

    provide: <TerraformElementType, ConfigType, SharedType>(terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>, id: string, configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType>, description?: string) => TerraformInjectorElementContainer<TerraformElementType, SharedType>

    Type declaration

    inject: () => Promise<void>

    Type declaration

    inject: () => Promise<void>

    Type declaration

      • (): Promise<void>
      • Commit dependency injection for all the elements below the scope level.

        -

        Returns Promise<void>

    provide: <TerraformElementType, ConfigType, SharedType>(terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>, id: string, configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<ConfigType, SharedType>, description?: string) => TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

    Type declaration

    provide: <TerraformElementType, ConfigType, SharedType>(terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>, id: string, configure: TerraformInjectorConfigureCallbackType<ConfigType, SharedType> | TerraformInjectorConfigureCallbackAsyncType<ConfigType, SharedType>, description?: string) => TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

    Type declaration

    You can provide any elements inheriting TerraformElement with provide method.

    And there is a special backend method only for providing an TerraformBackend element.

    You can later inject all the dependencies below the scope level of the instance by using inject method.

    -

    Hierarchy

    Index

    Methods

    Hierarchy

    Index

    Methods

  • Optional description: string

    Optional description string.

    -
  • Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

    Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

    Hierarchy

    Implemented by

    Index

    Methods

    Hierarchy

    Implemented by

    Index

    Methods

    Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>

    • inject(): void

    Returns TerraformInjectorElementContainer<TerraformBackendType, SharedType>

    • inject(): void
    • Type parameters

      • TerraformElementType: TerraformElement<TerraformElementType>

      • ConfigType

      • SharedType = undefined

      Parameters

      • terraformElementClass: TerraformInjectorElementClassType<TerraformElementType, ConfigType>
        diff --git a/docs/interfaces/TerraformInjectorAsync.html b/docs/interfaces/TerraformInjectorAsync.html index b08c95b..974bcf3 100644 --- a/docs/interfaces/TerraformInjectorAsync.html +++ b/docs/interfaces/TerraformInjectorAsync.html @@ -3,7 +3,7 @@

        You can provide any elements inheriting TerraformElement with provide method.

        And there is a special backend method only for providing an TerraformBackend element.

        You can later inject all the dependencies below the scope level of the instance by using inject method.

        -

    Hierarchy

    Implemented by

    Index

    Methods

    Hierarchy

    Implemented by

    Index

    Methods

    Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

    • inject(): Promise<void>

    Returns TerraformInjectorElementContainerAsync<TerraformBackendType, SharedType>

    • inject(): Promise<void>
    • afterDependenciesInjected(afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void): TerraformInjectorElementContainer<TerraformElementType, SharedType>

    Returns TerraformInjectorElementContainer<TerraformElementType, SharedType>

    • afterDependenciesInjected(afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void): TerraformInjectorElementContainer<TerraformElementType, SharedType>
    • afterInitElement(afterInitCallback: (element: TerraformElementType, shared: SharedType) => void): TerraformInjectorElementContainer<TerraformElementType, SharedType>

    Returns TerraformInjectorElementContainer<TerraformElementType, SharedType>

    • afterInitElement(afterInitCallback: (element: TerraformElementType, shared: SharedType) => void): TerraformInjectorElementContainer<TerraformElementType, SharedType>
    • afterDependenciesInjected(afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void | Promise<void>): TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

    Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

    • afterDependenciesInjected(afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void | Promise<void>): TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>
    • Add after dependencies injected callback. Callback will run after dependency injection process is completed.

      You can add multiple callbacks, then they will be executed in sequence.

      Parameters

      • afterDependenciesInjectedCallback: (element: TerraformElementType, shared: SharedType) => void | Promise<void>

        Action block to execute after di process

        -
          • (element: TerraformElementType, shared: SharedType): void | Promise<void>
          • Parameters

            • element: TerraformElementType
            • shared: SharedType

            Returns void | Promise<void>

      Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>

    Returns TerraformInjectorElementContainerAsync<TerraformElementType, SharedType>