@junobuild/config 0.0.9 → 0.0.10
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.
package/README.md
CHANGED
|
@@ -101,10 +101,11 @@ Represents the overall configuration for Juno.
|
|
|
101
101
|
|
|
102
102
|
Represents the collections configuration for a satellite in a development environment.
|
|
103
103
|
|
|
104
|
-
| Property
|
|
105
|
-
|
|
|
106
|
-
| `
|
|
107
|
-
| `
|
|
104
|
+
| Property | Type | Description |
|
|
105
|
+
| ----------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
106
|
+
| `datastore` | `SatelliteDevDataStoreCollection[] or undefined` | The datastore collections configuration. type: {SatelliteDevDataStoreCollection[]}optional |
|
|
107
|
+
| `db` | `SatelliteDevDataStoreCollection[] or undefined` | The datastore collections configuration.This property is deprecated. Use {@link datastore} instead. deprecatedtype: {SatelliteDevDbCollection[]} |
|
|
108
|
+
| `storage` | `SatelliteDevStorageCollection[] or undefined` | The storage collections configuration. type: {SatelliteDevStorageCollection[]}optional |
|
|
108
109
|
|
|
109
110
|
#### :gear: SatelliteDevController
|
|
110
111
|
|
|
@@ -136,6 +137,7 @@ Represents the development configuration for Juno.
|
|
|
136
137
|
|
|
137
138
|
- [ENCODING_TYPE](#gear-encoding_type)
|
|
138
139
|
- [JunoConfigMode](#gear-junoconfigmode)
|
|
140
|
+
- [SatelliteDevDataStoreCollection](#gear-satellitedevdatastorecollection)
|
|
139
141
|
- [SatelliteDevDbCollection](#gear-satellitedevdbcollection)
|
|
140
142
|
- [SatelliteDevStorageCollection](#gear-satellitedevstoragecollection)
|
|
141
143
|
- [JunoDevConfigFn](#gear-junodevconfigfn)
|
|
@@ -157,11 +159,11 @@ Represents the development configuration for Juno.
|
|
|
157
159
|
|
|
158
160
|
[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/types/juno.env.ts#L5)
|
|
159
161
|
|
|
160
|
-
#### :gear:
|
|
162
|
+
#### :gear: SatelliteDevDataStoreCollection
|
|
161
163
|
|
|
162
|
-
| Type
|
|
163
|
-
|
|
|
164
|
-
| `
|
|
164
|
+
| Type | Type |
|
|
165
|
+
| --------------------------------- | ------ |
|
|
166
|
+
| `SatelliteDevDataStoreCollection` | `Omit< |
|
|
165
167
|
|
|
166
168
|
Rule,
|
|
167
169
|
'createdAt' or 'updatedAt' or 'maxSize' or 'version'
|
|
@@ -170,6 +172,14 @@ Rule,
|
|
|
170
172
|
|
|
171
173
|
[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L7)
|
|
172
174
|
|
|
175
|
+
#### :gear: SatelliteDevDbCollection
|
|
176
|
+
|
|
177
|
+
| Type | Type |
|
|
178
|
+
| -------------------------- | --------------------------------- |
|
|
179
|
+
| `SatelliteDevDbCollection` | `SatelliteDevDataStoreCollection` |
|
|
180
|
+
|
|
181
|
+
[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L19)
|
|
182
|
+
|
|
173
183
|
#### :gear: SatelliteDevStorageCollection
|
|
174
184
|
|
|
175
185
|
| Type | Type |
|
|
@@ -181,7 +191,7 @@ Rule,
|
|
|
181
191
|
|
|
182
192
|
> ` |
|
|
183
193
|
|
|
184
|
-
[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#
|
|
194
|
+
[:link: Source](https://github.com/junobuild/juno-js/tree/main/packages/config/src/satellite/dev/juno.dev.config.ts#L25)
|
|
185
195
|
|
|
186
196
|
#### :gear: JunoDevConfigFn
|
|
187
197
|
|
|
@@ -1,9 +1,17 @@
|
|
|
1
1
|
import type { Rule } from '../types/rules';
|
|
2
2
|
/**
|
|
3
3
|
* Represents a database collection configuration for a satellite in a development environment.
|
|
4
|
-
* @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>}
|
|
4
|
+
* @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>} SatelliteDevDataStoreCollection
|
|
5
5
|
*/
|
|
6
|
-
export type
|
|
6
|
+
export type SatelliteDevDataStoreCollection = Omit<Rule, 'createdAt' | 'updatedAt' | 'maxSize' | 'version'>;
|
|
7
|
+
/**
|
|
8
|
+
* This type is an alias for SatelliteDevDataStoreCollection and is now deprecated.
|
|
9
|
+
*
|
|
10
|
+
* @see SatelliteDevDataStoreCollection
|
|
11
|
+
* @deprecated Use {@link SatelliteDevDataStoreCollection} instead.
|
|
12
|
+
* @typedef {SatelliteDevDataStoreCollection} SatelliteDevDbCollection
|
|
13
|
+
*/
|
|
14
|
+
export type SatelliteDevDbCollection = SatelliteDevDataStoreCollection;
|
|
7
15
|
/**
|
|
8
16
|
* Represents a storage collection configuration for a satellite in a development environment.
|
|
9
17
|
* @typedef {Omit<Rule, 'createdAt' | 'updatedAt' | 'maxCapacity' | 'version'>} SatelliteDevStorageCollection
|
|
@@ -15,10 +23,18 @@ export type SatelliteDevStorageCollection = Omit<Rule, 'createdAt' | 'updatedAt'
|
|
|
15
23
|
*/
|
|
16
24
|
export interface SatelliteDevCollections {
|
|
17
25
|
/**
|
|
18
|
-
* The
|
|
19
|
-
* @type {
|
|
26
|
+
* The datastore collections configuration.
|
|
27
|
+
* @type {SatelliteDevDataStoreCollection[]}
|
|
20
28
|
* @optional
|
|
21
29
|
*/
|
|
30
|
+
datastore?: SatelliteDevDataStoreCollection[];
|
|
31
|
+
/**
|
|
32
|
+
* The datastore collections configuration.
|
|
33
|
+
* This property is deprecated. Use {@link datastore} instead.
|
|
34
|
+
*
|
|
35
|
+
* @deprecated
|
|
36
|
+
* @type {SatelliteDevDbCollection[]}
|
|
37
|
+
*/
|
|
22
38
|
db?: SatelliteDevDbCollection[];
|
|
23
39
|
/**
|
|
24
40
|
* The storage collections configuration.
|