@vertx/config - npm Package Compare versions

Comparing version 3.9.1 to 3.9.2

index.mjs

+/*
+ * Copyright 2020 ES4X
+ *
+ * ES4X licenses this file to you under the Apache License, version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+/// <reference types="@vertx/config" />
+
+/**
+ * @typedef { import("es4x") } Java
+ */
+export const ConfigRetriever = Java.type('io.vertx.config.ConfigRetriever');

mod.js

+/*
+ * Copyright 2020 ES4X
+ *
+ * ES4X licenses this file to you under the Apache License, version 2.0
+ * (the "License"); you may not use this file except in compliance with the
+ * License.  You may obtain a copy of the License at:
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+ * License for the specific language governing permissions and limitations
+ * under the License.
+ */
+
+export * from './options.mjs';
+export * from './index.mjs';

package.json

 {
   "name" : "@vertx/config",
   "description" : "Generated Eclipse Vert.x bindings for 'vertx-config'",
-  "version" : "3.9.1",
+  "version" : "3.9.2",
   "license" : "Apache-2.0",
@@ -10,9 +10,9 @@ "public" : true,
     "artifactId" : "vertx-config",
-    "version" : "3.9.1"
+    "version" : "3.9.2"
   },
   "dependencies" : {
-    "@vertx/core" : "3.9.1"
+    "@vertx/core" : "3.9.2"
   },
   "main" : "index.js",
-  "module" : "module.mjs",
+  "module" : "index.mjs",
   "types" : "index.d.ts",
@@ -19,0 +19,0 @@ "sideEffects" : false,

README.md

@@ -14,4 +14,29 @@ ![npm (scoped)](https://img.shields.io/npm/v/@vertx/config.svg)
 
-This is a meta package, meaning that it contains only metadata for the build.
+Import the required `API`/`Enum`/`DataObject` and profit!
 
+```js
+// Base API
+import * as API from '@vertx/config';
+// DataObject's
+import * as OPTIONS from '@vertx/config/options';
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
+```
+
+## Typescript
+
+This package includes [Typescript](http://www.typescriptlang.org/) typedefinitions and your IDE should find then automatically.
+
+When working in a project you can enable type hinting for the runtime as:
+
+```js
+/// <definition types="es4x" />
+// @ts-check
+
+// your TypeScript code here...
+```
+
 ## Links
@@ -18,0 +43,0 @@

module.mjs

-/*
- * Copyright 2020 ES4X
- *
- * ES4X licenses this file to you under the Apache License, version 2.0
- * (the "License"); you may not use this file except in compliance with the
- * License.  You may obtain a copy of the License at:
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
- * License for the specific language governing permissions and limitations
- * under the License.
- */
-
-/// <reference types="@vertx/config" />
-
-/**
- * @typedef { import("es4x") } Java
- */
-export const ConfigRetriever = Java.type('io.vertx.config.ConfigRetriever');

No alert changes

Improved metrics

Total package byte prevSize

12586

10.09%

Number of package files

9

12.5%

Lines of code

294

6.14%

Number of lines in readme file

45

125%

Dependency changes

• + Added

  @vertx/core@3.9.2
  (transitive)

• - Removed

  @vertx/core@3.9.1
  (transitive)

• Updated

  @vertx/core@3.9.2