Skip to content

Commit b2d73cc

Browse files
committed
chore(deps): upgrade deps and API doc
1 parent 3993763 commit b2d73cc

File tree

6 files changed

+1723
-1703
lines changed

6 files changed

+1723
-1703
lines changed

.projen/deps.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.projenrc.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ const project = new awscdk.AwsCdkConstructLibrary({
33
author: 'Cameron Magee',
44
authorAddress: '[email protected]',
55
copyrightOwner: 'Amazon.com, Inc. or its affiliates. All Rights Reserved.',
6-
cdkVersion: '2.1.0',
7-
constructsVersion: '10.0.5',
6+
cdkVersion: '2.59.0',
7+
constructsVersion: '10.1.215',
88
defaultReleaseBranch: 'main',
99
name: 'cdk-image-pipeline',
1010
repositoryUrl: 'https://github.com/aws-samples/cdk-image-pipeline.git',
@@ -17,7 +17,7 @@ const project = new awscdk.AwsCdkConstructLibrary({
1717
license: 'MIT-0',
1818
pullRequestTemplateContents: ['# Fixes', ' ', ' ', 'By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.'],
1919
releaseToNpm: true,
20-
devDeps: ['@types/prettier@2.6.0'],
20+
devDeps: ['@types/prettier@2.7.2'],
2121
});
2222

2323
project.addPeerDeps('aws-cdk-lib');

API.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Returns a string representation of this construct.
6262

6363
---
6464

65-
##### ~~`isConstruct`~~ <a name="isConstruct" id="cdk-image-pipeline.ImagePipeline.isConstruct"></a>
65+
##### `isConstruct` <a name="isConstruct" id="cdk-image-pipeline.ImagePipeline.isConstruct"></a>
6666

6767
```typescript
6868
import { ImagePipeline } from 'cdk-image-pipeline'
@@ -72,6 +72,20 @@ ImagePipeline.isConstruct(x: any)
7272

7373
Checks if `x` is a construct.
7474

75+
Use this method instead of `instanceof` to properly detect `Construct`
76+
instances, even when the construct library is symlinked.
77+
78+
Explanation: in JavaScript, multiple copies of the `constructs` library on
79+
disk are seen as independent, completely different libraries. As a
80+
consequence, the class `Construct` in each copy of the `constructs` library
81+
is seen as a different class, and an instance of one class will not test as
82+
`instanceof` the other class. `npm install` will not create installations
83+
like this, but users may manually symlink construct libraries together or
84+
use a monorepo tool: in those cases, multiple copies of the `constructs`
85+
library can be accidentally installed, and `instanceof` will behave
86+
unpredictably. It is safest to avoid using `instanceof`, and using
87+
this type-testing method instead.
88+
7589
###### `x`<sup>Required</sup> <a name="x" id="cdk-image-pipeline.ImagePipeline.isConstruct.parameter.x"></a>
7690

7791
- *Type:* any

0 commit comments

Comments
 (0)