Skip to content

chore: Renamed 'DependableTrait' to new name 'Dependable' #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 14, 2022
Merged

chore: Renamed 'DependableTrait' to new name 'Dependable' #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53910d9
docs: Renamed 'DependableTrait' to new name 'Dependable'
ThomasSteinbach Jun 2, 2022
3240b0c
docs: Changed type 'Dependable' to 'IDependable'
ThomasSteinbach Jun 14, 2022
837da01
chore: run 'yarn build' to update 'API.md'
Jun 14, 2022
102013b
Merge branch '10.x' into patch-2
mergify[bot] Jun 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ __Implemented by__: [Construct](#constructs-construct), [DependencyGroup](#const
Trait marker for classes that can be depended upon.

The presence of this interface indicates that an object has
an `IDependableTrait` implementation.
an `IDependable` implementation.

This interface can be used to take an (ordering) dependency on a set of
constructs. An ordering dependency implies that the resources represented by
Expand Down
8 changes: 4 additions & 4 deletions src/dependency.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { IConstruct } from './construct';
* Trait marker for classes that can be depended upon
*
* The presence of this interface indicates that an object has
* an `IDependableTrait` implementation.
* an `IDependable` implementation.
*
* This interface can be used to take an (ordering) dependency on a set of
* constructs. An ordering dependency implies that the resources represented by
Expand Down Expand Up @@ -64,11 +64,11 @@ const DEPENDABLE_SYMBOL = Symbol.for('@aws-cdk/core.DependableTrait');
* @example
*
* // Usage
* const roots = DependableTrait.get(construct).dependencyRoots;
* const roots = Dependable.of(construct).dependencyRoots;
*
* // Definition
* DependableTrait.implement(construct, {
* get dependencyRoots() { return []; }
* Dependable.implement(construct, {
* dependencyRoots: [construct],
* });
*
* @experimental
Expand Down