cdk8s-redis 0.1.782 → 0.1.784

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/.jsii +4 -4
  2. package/API.md +157 -30
  3. package/lib/redis.js +1 -1
  4. package/package.json +9 -9
package/.jsii CHANGED
@@ -7,7 +7,7 @@
7
7
  "url": "https://aws.amazon.com"
8
8
  },
9
9
  "dependencies": {
10
- "cdk8s": "^2.68.4",
10
+ "cdk8s": "^2.68.91",
11
11
  "constructs": "^10.3.0"
12
12
  },
13
13
  "dependencyClosure": {
@@ -67,7 +67,7 @@
67
67
  "stability": "experimental"
68
68
  },
69
69
  "homepage": "https://github.com/cdk8s-team/cdk8s-redis.git",
70
- "jsiiVersion": "1.102.0 (build e354887)",
70
+ "jsiiVersion": "1.103.0 (build 3b9adc4)",
71
71
  "keywords": [
72
72
  "cache",
73
73
  "cdk8s",
@@ -254,6 +254,6 @@
254
254
  "symbolId": "src/redis:RedisOptions"
255
255
  }
256
256
  },
257
- "version": "0.1.782",
258
- "fingerprint": "pylTM0wSgJmI5z7ESE7o76eRYbt7Cdn90BrjN8/b8fs="
257
+ "version": "0.1.784",
258
+ "fingerprint": "p5WMaNPvLSclEPAxTsNl4SttH8ojc4kRijkT8qn/DAA="
259
259
  }
package/API.md CHANGED
@@ -1,65 +1,192 @@
1
- # API Reference
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
2
 
3
- **Classes**
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
4
 
5
- Name|Description
6
- ----|-----------
7
- [Redis](#cdk8s-redis-redis)|*No description*
5
+ ### Redis <a name="Redis" id="cdk8s-redis.Redis"></a>
8
6
 
7
+ #### Initializers <a name="Initializers" id="cdk8s-redis.Redis.Initializer"></a>
9
8
 
10
- **Structs**
9
+ ```typescript
10
+ import { Redis } from 'cdk8s-redis'
11
11
 
12
- Name|Description
13
- ----|-----------
14
- [RedisOptions](#cdk8s-redis-redisoptions)|*No description*
12
+ new Redis(scope: Construct, id: string, options?: RedisOptions)
13
+ ```
15
14
 
15
+ | **Name** | **Type** | **Description** |
16
+ | --- | --- | --- |
17
+ | <code><a href="#cdk8s-redis.Redis.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
18
+ | <code><a href="#cdk8s-redis.Redis.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
19
+ | <code><a href="#cdk8s-redis.Redis.Initializer.parameter.options">options</a></code> | <code><a href="#cdk8s-redis.RedisOptions">RedisOptions</a></code> | *No description.* |
16
20
 
21
+ ---
17
22
 
18
- ## class Redis 🔹 <a id="cdk8s-redis-redis"></a>
23
+ ##### `scope`<sup>Required</sup> <a name="scope" id="cdk8s-redis.Redis.Initializer.parameter.scope"></a>
19
24
 
25
+ - *Type:* constructs.Construct
20
26
 
27
+ ---
21
28
 
22
- __Implements__: [IConstruct](#constructs-iconstruct), [IDependable](#constructs-idependable)
23
- __Extends__: [Construct](#constructs-construct)
29
+ ##### `id`<sup>Required</sup> <a name="id" id="cdk8s-redis.Redis.Initializer.parameter.id"></a>
24
30
 
25
- ### Initializer
31
+ - *Type:* string
26
32
 
33
+ ---
27
34
 
35
+ ##### `options`<sup>Optional</sup> <a name="options" id="cdk8s-redis.Redis.Initializer.parameter.options"></a>
28
36
 
37
+ - *Type:* <a href="#cdk8s-redis.RedisOptions">RedisOptions</a>
29
38
 
30
- ```ts
31
- new Redis(scope: Construct, id: string, options?: RedisOptions)
39
+ ---
40
+
41
+ #### Methods <a name="Methods" id="Methods"></a>
42
+
43
+ | **Name** | **Description** |
44
+ | --- | --- |
45
+ | <code><a href="#cdk8s-redis.Redis.toString">toString</a></code> | Returns a string representation of this construct. |
46
+
47
+ ---
48
+
49
+ ##### `toString` <a name="toString" id="cdk8s-redis.Redis.toString"></a>
50
+
51
+ ```typescript
52
+ public toString(): string
53
+ ```
54
+
55
+ Returns a string representation of this construct.
56
+
57
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
58
+
59
+ | **Name** | **Description** |
60
+ | --- | --- |
61
+ | <code><a href="#cdk8s-redis.Redis.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
62
+
63
+ ---
64
+
65
+ ##### `isConstruct` <a name="isConstruct" id="cdk8s-redis.Redis.isConstruct"></a>
66
+
67
+ ```typescript
68
+ import { Redis } from 'cdk8s-redis'
69
+
70
+ Redis.isConstruct(x: any)
32
71
  ```
33
72
 
34
- * **scope** (<code>[Construct](#constructs-construct)</code>) *No description*
35
- * **id** (<code>string</code>) *No description*
36
- * **options** (<code>[RedisOptions](#cdk8s-redis-redisoptions)</code>) *No description*
37
- * **labels** (<code>Map<string, string></code>) Extra labels to associate with resources. __*Default*__: none
38
- * **replicas** (<code>number</code>) Number of replicas. __*Default*__: 2
73
+ Checks if `x` is a construct.
74
+
75
+ Use this method instead of `instanceof` to properly detect `Construct`
76
+ instances, even when the construct library is symlinked.
39
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.
40
88
 
89
+ ###### `x`<sup>Required</sup> <a name="x" id="cdk8s-redis.Redis.isConstruct.parameter.x"></a>
41
90
 
42
- ### Properties
91
+ - *Type:* any
43
92
 
93
+ Any object.
44
94
 
45
- Name | Type | Description
46
- -----|------|-------------
47
- **primaryHost**🔹 | <code>string</code> | The DNS host for the primary service.
48
- **replicaHost**🔹 | <code>string</code> | The DNS host for the replica service.
95
+ ---
49
96
 
97
+ #### Properties <a name="Properties" id="Properties"></a>
50
98
 
99
+ | **Name** | **Type** | **Description** |
100
+ | --- | --- | --- |
101
+ | <code><a href="#cdk8s-redis.Redis.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
102
+ | <code><a href="#cdk8s-redis.Redis.property.primaryHost">primaryHost</a></code> | <code>string</code> | The DNS host for the primary service. |
103
+ | <code><a href="#cdk8s-redis.Redis.property.replicaHost">replicaHost</a></code> | <code>string</code> | The DNS host for the replica service. |
51
104
 
52
- ## struct RedisOptions 🔹 <a id="cdk8s-redis-redisoptions"></a>
105
+ ---
106
+
107
+ ##### `node`<sup>Required</sup> <a name="node" id="cdk8s-redis.Redis.property.node"></a>
108
+
109
+ ```typescript
110
+ public readonly node: Node;
111
+ ```
112
+
113
+ - *Type:* constructs.Node
114
+
115
+ The tree node.
116
+
117
+ ---
118
+
119
+ ##### `primaryHost`<sup>Required</sup> <a name="primaryHost" id="cdk8s-redis.Redis.property.primaryHost"></a>
120
+
121
+ ```typescript
122
+ public readonly primaryHost: string;
123
+ ```
53
124
 
125
+ - *Type:* string
54
126
 
127
+ The DNS host for the primary service.
55
128
 
129
+ ---
130
+
131
+ ##### `replicaHost`<sup>Required</sup> <a name="replicaHost" id="cdk8s-redis.Redis.property.replicaHost"></a>
132
+
133
+ ```typescript
134
+ public readonly replicaHost: string;
135
+ ```
136
+
137
+ - *Type:* string
138
+
139
+ The DNS host for the replica service.
140
+
141
+ ---
142
+
143
+
144
+ ## Structs <a name="Structs" id="Structs"></a>
145
+
146
+ ### RedisOptions <a name="RedisOptions" id="cdk8s-redis.RedisOptions"></a>
147
+
148
+ #### Initializer <a name="Initializer" id="cdk8s-redis.RedisOptions.Initializer"></a>
149
+
150
+ ```typescript
151
+ import { RedisOptions } from 'cdk8s-redis'
152
+
153
+ const redisOptions: RedisOptions = { ... }
154
+ ```
155
+
156
+ #### Properties <a name="Properties" id="Properties"></a>
157
+
158
+ | **Name** | **Type** | **Description** |
159
+ | --- | --- | --- |
160
+ | <code><a href="#cdk8s-redis.RedisOptions.property.labels">labels</a></code> | <code>{[ key: string ]: string}</code> | Extra labels to associate with resources. |
161
+ | <code><a href="#cdk8s-redis.RedisOptions.property.replicas">replicas</a></code> | <code>number</code> | Number of replicas. |
162
+
163
+ ---
164
+
165
+ ##### `labels`<sup>Optional</sup> <a name="labels" id="cdk8s-redis.RedisOptions.property.labels"></a>
166
+
167
+ ```typescript
168
+ public readonly labels: {[ key: string ]: string};
169
+ ```
170
+
171
+ - *Type:* {[ key: string ]: string}
172
+ - *Default:* none
173
+
174
+ Extra labels to associate with resources.
175
+
176
+ ---
177
+
178
+ ##### `replicas`<sup>Optional</sup> <a name="replicas" id="cdk8s-redis.RedisOptions.property.replicas"></a>
179
+
180
+ ```typescript
181
+ public readonly replicas: number;
182
+ ```
56
183
 
184
+ - *Type:* number
185
+ - *Default:* 2
57
186
 
187
+ Number of replicas.
58
188
 
59
- Name | Type | Description
60
- -----|------|-------------
61
- **labels**?🔹 | <code>Map<string, string></code> | Extra labels to associate with resources.<br/>__*Default*__: none
62
- **replicas**?🔹 | <code>number</code> | Number of replicas.<br/>__*Default*__: 2
189
+ ---
63
190
 
64
191
 
65
192
 
package/lib/redis.js CHANGED
@@ -46,5 +46,5 @@ class Redis extends constructs_1.Construct {
46
46
  }
47
47
  exports.Redis = Redis;
48
48
  _a = JSII_RTTI_SYMBOL_1;
49
- Redis[_a] = { fqn: "cdk8s-redis.Redis", version: "0.1.782" };
49
+ Redis[_a] = { fqn: "cdk8s-redis.Redis", version: "0.1.784" };
50
50
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVkaXMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcmVkaXMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSwyQ0FBdUM7QUFDdkMsNkRBQXlEO0FBZ0J6RCxNQUFhLEtBQU0sU0FBUSxzQkFBUztJQVdsQyxZQUFZLEtBQWdCLEVBQUUsRUFBVSxFQUFFLFVBQXdCLEVBQUc7UUFDbkUsS0FBSyxDQUFDLEtBQUssRUFBRSxFQUFFLENBQUMsQ0FBQztRQUVqQixNQUFNLE9BQU8sR0FBRyxJQUFJLHNDQUFpQixDQUFDLElBQUksRUFBRSxTQUFTLEVBQUU7WUFDckQsS0FBSyxFQUFFLDJCQUEyQjtZQUNsQyxhQUFhLEVBQUUsSUFBSTtZQUNuQixZQUFZLEVBQUUsSUFBSTtZQUNsQixhQUFhLEVBQUUsU0FBUztZQUN4QixHQUFHLEVBQUUsRUFBRSxjQUFjLEVBQUUsS0FBSyxFQUFFO1lBQzlCLE1BQU0sRUFBRTtnQkFDTixHQUFHLEVBQUUsT0FBTztnQkFDWixJQUFJLEVBQUUsU0FBUztnQkFDZixHQUFHLE9BQU8sQ0FBQyxNQUFNO2FBQ2xCO1NBQ0YsQ0FBQyxDQUFDO1FBRUgsSUFBSSxDQUFDLFdBQVcsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDO1FBRWhDLE1BQU0sUUFBUSxHQUFHLE9BQU8sQ0FBQyxRQUFRLElBQUksQ0FBQyxDQUFDO1FBQ3ZDLElBQUksUUFBUSxHQUFHLENBQUMsRUFBRTtZQUNoQixNQUFNLE9BQU8sR0FBRyxJQUFJLHNDQUFpQixDQUFDLElBQUksRUFBRSxTQUFTLEVBQUU7Z0JBQ3JELEtBQUssRUFBRSx3Q0FBd0M7Z0JBQy9DLGFBQWEsRUFBRSxTQUFTO2dCQUN4QixhQUFhLEVBQUUsSUFBSTtnQkFDbkIsWUFBWSxFQUFFLElBQUk7Z0JBQ2xCLEdBQUcsRUFBRSxFQUFFLGNBQWMsRUFBRSxLQUFLLEVBQUUseUJBQXlCLEVBQUUsSUFBSSxDQUFDLFdBQVcsRUFBRTtnQkFDM0UsUUFBUSxFQUFFLFFBQVE7Z0JBQ2xCLE1BQU0sRUFBRTtvQkFDTixHQUFHLEVBQUUsT0FBTztvQkFDWixJQUFJLEVBQUUsU0FBUztvQkFDZixHQUFHLE9BQU8sQ0FBQyxNQUFNO2lCQUNsQjthQUNGLENBQUMsQ0FBQztZQUVILElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQztTQUNqQzthQUFNO1lBQ0wsNkRBQTZEO1lBQzdELElBQUksQ0FBQyxXQUFXLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQztTQUNqQztJQUNILENBQUM7O0FBbERILHNCQW1EQyIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCB7IENvbnN0cnVjdCB9IGZyb20gJ2NvbnN0cnVjdHMnO1xuaW1wb3J0IHsgU2VydmljZURlcGxveW1lbnQgfSBmcm9tICcuL3NlcnZpY2UtZGVwbG95bWVudCc7XG5cbmV4cG9ydCBpbnRlcmZhY2UgUmVkaXNPcHRpb25zIHtcbiAgLyoqXG4gICAqIE51bWJlciBvZiByZXBsaWNhcy5cbiAgICogQGRlZmF1bHQgMlxuICAgKi9cbiAgcmVhZG9ubHkgcmVwbGljYXM/OiBudW1iZXI7XG5cbiAgLyoqXG4gICAqIEV4dHJhIGxhYmVscyB0byBhc3NvY2lhdGUgd2l0aCByZXNvdXJjZXMuXG4gICAqIEBkZWZhdWx0IC0gbm9uZVxuICAgKi9cbiAgcmVhZG9ubHkgbGFiZWxzPzogeyBbbmFtZTogc3RyaW5nXTogc3RyaW5nIH07XG59XG5cbmV4cG9ydCBjbGFzcyBSZWRpcyBleHRlbmRzIENvbnN0cnVjdCB7XG4gIC8qKlxuICAgKiBUaGUgRE5TIGhvc3QgZm9yIHRoZSBwcmltYXJ5IHNlcnZpY2UuXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgcHJpbWFyeUhvc3Q6IHN0cmluZztcblxuICAvKipcbiAgICogVGhlIEROUyBob3N0IGZvciB0aGUgcmVwbGljYSBzZXJ2aWNlLlxuICAgKi9cbiAgcHVibGljIHJlYWRvbmx5IHJlcGxpY2FIb3N0OiBzdHJpbmc7XG5cbiAgY29uc3RydWN0b3Ioc2NvcGU6IENvbnN0cnVjdCwgaWQ6IHN0cmluZywgb3B0aW9uczogUmVkaXNPcHRpb25zID0geyB9KSB7XG4gICAgc3VwZXIoc2NvcGUsIGlkKTtcblxuICAgIGNvbnN0IHByaW1hcnkgPSBuZXcgU2VydmljZURlcGxveW1lbnQodGhpcywgJ3ByaW1hcnknLCB7XG4gICAgICBpbWFnZTogJ3JlZ2lzdHJ5Lms4cy5pby9yZWRpczplMmUnLFxuICAgICAgY29udGFpbmVyUG9ydDogNjM3OSxcbiAgICAgIGV4dGVybmFsUG9ydDogNjM3OSxcbiAgICAgIGNvbnRhaW5lck5hbWU6ICdwcmltYXJ5JyxcbiAgICAgIGVudjogeyBHRVRfSE9TVFNfRlJPTTogJ2RucycgfSxcbiAgICAgIGxhYmVsczoge1xuICAgICAgICBhcHA6ICdyZWRpcycsXG4gICAgICAgIHJvbGU6ICdwcmltYXJ5JyxcbiAgICAgICAgLi4ub3B0aW9ucy5sYWJlbHMsXG4gICAgICB9LFxuICAgIH0pO1xuXG4gICAgdGhpcy5wcmltYXJ5SG9zdCA9IHByaW1hcnkuaG9zdDtcblxuICAgIGNvbnN0IHJlcGxpY2FzID0gb3B0aW9ucy5yZXBsaWNhcyA/PyAyO1xuICAgIGlmIChyZXBsaWNhcyA+IDApIHtcbiAgICAgIGNvbnN0IHJlcGxpY2EgPSBuZXcgU2VydmljZURlcGxveW1lbnQodGhpcywgJ3JlcGxpY2EnLCB7XG4gICAgICAgIGltYWdlOiAnZ2NyLmlvL2dvb2dsZV9zYW1wbGVzL2diLXJlZGlzc2xhdmU6djEnLFxuICAgICAgICBjb250YWluZXJOYW1lOiAncmVwbGljYScsXG4gICAgICAgIGNvbnRhaW5lclBvcnQ6IDYzNzksXG4gICAgICAgIGV4dGVybmFsUG9ydDogNjM3OSxcbiAgICAgICAgZW52OiB7IEdFVF9IT1NUU19GUk9NOiAnZW52JywgUkVESVNfTUFTVEVSX1NFUlZJQ0VfSE9TVDogdGhpcy5wcmltYXJ5SG9zdCB9LFxuICAgICAgICByZXBsaWNhczogcmVwbGljYXMsXG4gICAgICAgIGxhYmVsczoge1xuICAgICAgICAgIGFwcDogJ3JlZGlzJyxcbiAgICAgICAgICByb2xlOiAncmVwbGljYScsXG4gICAgICAgICAgLi4ub3B0aW9ucy5sYWJlbHMsXG4gICAgICAgIH0sXG4gICAgICB9KTtcblxuICAgICAgdGhpcy5yZXBsaWNhSG9zdCA9IHJlcGxpY2EuaG9zdDtcbiAgICB9IGVsc2Uge1xuICAgICAgLy8gaWYgd2UgaGF2ZSBubyBzbGF2ZSwgdGhlbiB1c2UgdGhlIHNhbWUgaG9zdCBhcyB0aGUgcHJpbWFyeVxuICAgICAgdGhpcy5yZXBsaWNhSG9zdCA9IHByaW1hcnkuaG9zdDtcbiAgICB9XG4gIH1cbn1cbiJdfQ==
package/package.json CHANGED
@@ -42,12 +42,13 @@
42
42
  "organization": false
43
43
  },
44
44
  "devDependencies": {
45
- "@cdk8s/projen-common": "^0.0.536",
45
+ "@cdk8s/projen-common": "^0.0.541",
46
46
  "@types/jest": "^27",
47
47
  "@types/node": "16.18.78",
48
48
  "@typescript-eslint/eslint-plugin": "^7",
49
49
  "@typescript-eslint/parser": "^7",
50
- "cdk8s": "2.68.4",
50
+ "cdk8s": "2.68.91",
51
+ "commit-and-tag-version": "^12",
51
52
  "constructs": "10.3.0",
52
53
  "eslint": "^8",
53
54
  "eslint-import-resolver-typescript": "^2.7.1",
@@ -55,17 +56,16 @@
55
56
  "jest": "^27",
56
57
  "jest-junit": "^15",
57
58
  "jsii": "1.x",
58
- "jsii-diff": "^1.102.0",
59
- "jsii-docgen": "^1.8.110",
60
- "jsii-pacmak": "^1.102.0",
59
+ "jsii-diff": "^1.103.0",
60
+ "jsii-docgen": "^10.5.0",
61
+ "jsii-pacmak": "^1.103.0",
61
62
  "jsii-rosetta": "1.x",
62
- "projen": "^0.84.13",
63
- "standard-version": "^9",
63
+ "projen": "^0.86.5",
64
64
  "ts-jest": "^27",
65
65
  "typescript": "^4.9.5"
66
66
  },
67
67
  "peerDependencies": {
68
- "cdk8s": "^2.68.4",
68
+ "cdk8s": "^2.68.91",
69
69
  "constructs": "^10.3.0"
70
70
  },
71
71
  "resolutions": {
@@ -89,7 +89,7 @@
89
89
  "publishConfig": {
90
90
  "access": "public"
91
91
  },
92
- "version": "0.1.782",
92
+ "version": "0.1.784",
93
93
  "jest": {
94
94
  "coverageProvider": "v8",
95
95
  "testMatch": [