Skip to main content

Class: Package

Defined in: packages/depot-cdk/src/stage-depot-package.ts:26

Creates a Depot Package containing the schemas, migrations, and other metadata for a Dataset

Extends​

  • IPackage

Constructors​

Constructor​

new Package(scope, id, props): Package

Defined in: packages/depot-cdk/src/stage-depot-package.ts:46

Create a Depot Package from an imported NPM Package module.

Parameters​

scope​

Construct

CDK Construct to add this resource to.

id​

string

unique ID for this resource.

props​

Package

The require imported NPM package properties.

Returns​

Package

Overrides​

IPackage.constructor

Properties​

id​

readonly id: string

Defined in: packages/depot-cdk/src/stage-depot-package.ts:27

Overrides​

IPackage.id

migrations?​

readonly optional migrations?: Migration[]

Defined in: packages/depot-cdk/src/stage-depot-package.ts:38

name​

readonly name: string

Defined in: packages/depot-cdk/src/stage-depot-package.ts:29

Overrides​

IPackage.name

node​

readonly node: Node

Defined in: node_modules/constructs/lib/construct.d.ts:289

The tree node.

Inherited from​

IPackage.node

schemas​

readonly schemas: ds.MergedSchemas

Defined in: packages/depot-cdk/src/stage-depot-package.ts:36

version?​

readonly optional version?: string

Defined in: packages/depot-cdk/src/stage-depot-package.ts:34

Deprecated​

No longer used (as of Depot 7.6.0) and will be removed

Methods​

toString()​

toString(): string

Defined in: node_modules/constructs/lib/construct.d.ts:314

Returns a string representation of this construct.

Returns​

string

Inherited from​

IPackage.toString

with()​

with(...mixins): IConstruct

Defined in: node_modules/constructs/lib/construct.d.ts:310

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters​

mixins​

...IMixin[]

The mixins to apply

Returns​

IConstruct

This construct for chaining

Inherited from​

IPackage.with

fromId()​

static fromId(scope, id, props): IPackage

Defined in: packages/depot-cdk/src/stage-depot-package.ts:72

Parameters​

scope​

Construct

id​

string

props​

IPackageProps

Returns​

IPackage

isConstruct()​

static isConstruct(x): x is Construct

Defined in: node_modules/constructs/lib/construct.d.ts:285

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters​

x​

any

Any object

Returns​

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from​

IPackage.isConstruct