Big News: Socket raises $60M Series C at a $1B valuation to secure software supply chains for AI-driven development.Announcement →
Sign In

@vertx/config

Package Overview
Dependencies
Maintainers
1
Versions
39
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vertx/config - npm Package Compare versions

Comparing version
3.8.3
 to
3.8.4
+10
-44
index.d.ts

@@ -27,14 +27,8 @@ /*

* Defines a configuration retriever that read configuration from
* {@link ConfigStore}
* and tracks changes periodically.
* @author <a href="http://escoffier.me">Clement Escoffier</a>
*
*/
* and tracks changes periodically.
*/
export abstract class ConfigRetriever {
/**
* Creates an instance of the default implementation of the {@link ConfigRetriever}.
* @param vertx the vert.x instance
* @param options the options, must not be {@code null}, must contain the list of configured store.
* @return the created instance.
*
*/

@@ -45,6 +39,3 @@ static create(vertx: Vertx, options: ConfigRetrieverOptions) : ConfigRetriever;

* Creates an instance of the default implementation of the {@link ConfigRetriever}, using the default
* settings (json file, system properties and environment variables).
* @param vertx the vert.x instance
* @return the created instance.
*
* settings (json file, system properties and environment variables).
*/

@@ -54,9 +45,4 @@ static create(vertx: Vertx) : ConfigRetriever;

/**
* Same as {@link ConfigRetriever#getConfig(Handler)}, but returning a {@link Future} object. The result is a
* {@link JsonObject}.
* @param retriever the config retrieve
* @return the future completed when the configuration is retrieved
* @deprecated removed in Vert.x 4 for {@code ConfigRetriever#getConfig()} method that returns a {@code Future<JsonObject>}
* in 3.x you can use instead {@code Future.future(retriever::getConfig)}
*
* Same as {@link ConfigRetriever#getConfig}, but returning a object. The result is a
* .
*/

@@ -66,7 +52,4 @@ static getConfigAsFuture(retriever: ConfigRetriever) : Future<{ [key: string]: any }>;

/**
* Reads the configuration from the different {@link ConfigStore}
* and computes the final configuration.
* @param completionHandler handler receiving the computed configuration, or a failure if the
* configuration cannot be retrieved
*
* Reads the configuration from the different
* and computes the final configuration.
*/

@@ -77,3 +60,2 @@ getConfig(completionHandler: ((res: AsyncResult<{ [key: string]: any }>) => void) | Handler<AsyncResult<{ [key: string]: any }>>) : void;

* Closes the retriever.
*
*/

@@ -84,4 +66,2 @@ close() : void;

* Gets the last computed configuration.
* @return the last configuration
*
*/

@@ -92,5 +72,3 @@ getCachedConfig() : { [key: string]: any };

* Registers a listener receiving configuration changes. This method cannot only be called if
* the configuration is broadcasted.
* @param listener the listener
*
* the configuration is broadcasted.
*/

@@ -101,5 +79,2 @@ listen(listener: ((res: ConfigChange) => void) | Handler<ConfigChange>) : void;

* Registers a handler called before every scan. This method is mostly used for logging purpose.
* @param function the function, must not be {@code null}
* @return the current config retriever
*
*/

@@ -109,9 +84,4 @@ setBeforeScanHandler(__function: ((res: void) => void) | Handler<void>) : ConfigRetriever;

/**
* Registers a handler that process the configuration before being injected into {@link #getConfig(Handler)} or {@link #listen(Handler)}. This allows
* the code to customize the configuration.
* @param processor the processor, must not be {@code null}. The method must not return {@code null}. The returned configuration is used. If the processor
* does not update the configuration, it must return the input configuration. If the processor throws an exception, the failure is passed
* to the {@link #getConfig(Handler)} handler.
* @return the current config retriever
*
* Registers a handler that process the configuration before being injected into {@link ConfigRetriever#getConfig} or {@link ConfigRetriever#listen}. This allows
* the code to customize the configuration.
*/

@@ -121,8 +91,4 @@ setConfigurationProcessor(processor: (arg: { [key: string]: any }) => { [key: string]: any }) : ConfigRetriever;

/**
*
* @return the stream of configurations. It's single stream (unicast) and that delivers the last known config
* and the successors periodically.
*
*/
configStream() : ReadStream<{ [key: string]: any }>;
}
+9
-72
options.d.ts

@@ -19,5 +19,3 @@ /*

* A structure representing a configuration change.
* @author <a href="http://escoffier.me">Clement Escoffier</a>
*
*/
*/
export class ConfigChange {

@@ -29,5 +27,2 @@

* Sets the new configuration.
* @param conf the new configuration, may be {@code null}. In this case, an empty JSON object is used.
* @return the current instance of {@link ConfigChange}
*
*/

@@ -38,5 +33,2 @@ getNewConfiguration(): { [key: string]: any };

* Sets the new configuration.
* @param conf the new configuration, may be {@code null}. In this case, an empty JSON object is used.
* @return the current instance of {@link ConfigChange}
*
*/

@@ -47,5 +39,2 @@ setNewConfiguration(newConfiguration: { [key: string]: any }): ConfigChange;

* Sets the previous configuration.
* @param conf the configuration, may be {@code null}. In this case an empty JSON object is used.
* @return the current instance of {@link ConfigChange}
*
*/

@@ -56,5 +45,2 @@ getPreviousConfiguration(): { [key: string]: any };

* Sets the previous configuration.
* @param conf the configuration, may be {@code null}. In this case an empty JSON object is used.
* @return the current instance of {@link ConfigChange}
*
*/

@@ -65,6 +51,4 @@ setPreviousConfiguration(previousConfiguration: { [key: string]: any }): ConfigChange;

/**
* Options to configure the {@code ConfigRetriever}.
* @author <a href="http://escoffier.me">Clement Escoffier</a>
*
*/
* Options to configure the <code>ConfigRetriever</code>.
*/
export class ConfigRetrieverOptions {

@@ -76,5 +60,2 @@

* Enables or disables the inclusion of the default stored in the configuration.
* @param includeDefaultStores {@code true} to include the default stores.
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -85,5 +66,2 @@ isIncludeDefaultStores(): boolean;

* Enables or disables the inclusion of the default stored in the configuration.
* @param includeDefaultStores {@code true} to include the default stores.
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -94,5 +72,2 @@ setIncludeDefaultStores(includeDefaultStores: boolean): ConfigRetrieverOptions;

* Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.
* @param scanPeriod the scan period in ms
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -103,5 +78,2 @@ getScanPeriod(): number;

* Configures the scan period, in ms. This is the time amount between two checks of the configuration updates.
* @param scanPeriod the scan period in ms
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -112,5 +84,2 @@ setScanPeriod(scanPeriod: number): ConfigRetrieverOptions;

* Sets the configuration stores.
* @param stores the list of stores.
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -121,5 +90,2 @@ getStores(): ConfigStoreOptions;

* Sets the configuration stores.
* @param stores the list of stores.
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -130,5 +96,2 @@ setStores(stores: ConfigStoreOptions): ConfigRetrieverOptions;

* Sets the configuration stores.
* @param stores the list of stores.
* @return the current {@link ConfigStoreOptions}
*
*/

@@ -140,8 +103,6 @@ addStore(stores: ConfigStoreOptions): ConfigRetrieverOptions;

* Data object representing the configuration of a configuration store. This object describes the configuration of a
* chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the
* retrieved configuration chunk, and you can also configures the store if it needs configuration to
* retrieve the configuration chunk.
* @author <a href="http://escoffier.me">Clement Escoffier</a>
*
*/
* chunk of configuration that you retrieve. It specifies its type (type of configuration store), the format of the
* retrieved configuration chunk, and you can also configures the store if it needs configuration to
* retrieve the configuration chunk.
*/
export class ConfigStoreOptions {

@@ -153,5 +114,2 @@

* Sets the configuration of the store
* @param config the data, can be {@code null}
* @return the current instance of {@link ConfigStoreOptions}
*
*/

@@ -162,5 +120,2 @@ getConfig(): { [key: string]: any };

* Sets the configuration of the store
* @param config the data, can be {@code null}
* @return the current instance of {@link ConfigStoreOptions}
*
*/

@@ -171,5 +126,2 @@ setConfig(config: { [key: string]: any }): ConfigStoreOptions;

* Sets the format of the configuration that is retrieved from the store.
* @param format the format, must not be {@code null}.
* @return the current instance of {@link ConfigStoreOptions}
*
*/

@@ -180,5 +132,2 @@ getFormat(): string;

* Sets the format of the configuration that is retrieved from the store.
* @param format the format, must not be {@code null}.
* @return the current instance of {@link ConfigStoreOptions}
*
*/

@@ -189,6 +138,3 @@ setFormat(format: string): ConfigStoreOptions;

* Sets whether or not the store is optional. When the configuration is retrieve, if an optional store
* returns a failure, the failure is ignored and an empty json object is used instead (for this store).
* @param optional whether or not the store is optional.
* @return the current instance of {@link ConfigStoreOptions}
*
* returns a failure, the failure is ignored and an empty json object is used instead (for this store).
*/

@@ -199,6 +145,3 @@ isOptional(): boolean;

* Sets whether or not the store is optional. When the configuration is retrieve, if an optional store
* returns a failure, the failure is ignored and an empty json object is used instead (for this store).
* @param optional whether or not the store is optional.
* @return the current instance of {@link ConfigStoreOptions}
*
* returns a failure, the failure is ignored and an empty json object is used instead (for this store).
*/

@@ -209,5 +152,2 @@ setOptional(optional: boolean): ConfigStoreOptions;

* Sets the configuration type
* @param type the type
* @return the current instance of {@link ConfigStoreOptions}
*
*/

@@ -218,7 +158,4 @@ getType(): string;

* Sets the configuration type
* @param type the type
* @return the current instance of {@link ConfigStoreOptions}
*
*/
setType(type: string): ConfigStoreOptions;
}
+3
-3
package.json
{
"name" : "@vertx/config",
"description" : "Generated Eclipse Vert.x bindings for 'vertx-config'",
"version" : "3.8.3",
"version" : "3.8.4",
"license" : "Apache-2.0",

@@ -10,6 +10,6 @@ "public" : true,

"artifactId" : "vertx-config",
"version" : "3.8.3"
"version" : "3.8.4"
},
"dependencies" : {
"@vertx/core" : "3.8.3"
"@vertx/core" : "3.8.4"
},

@@ -16,0 +16,0 @@ "main" : "index.js",