v-connection-string - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

index.d.ts

 /**
  * @license
- * Copyright (c) 2022 Micro Focus or one of its affiliates.
+ * Copyright (c) 2022-2023 Micro Focus or one of its affiliates.
  *
@@ -5,0 +5,0 @@ * Licensed under the Apache License, Version 2.0 (the "License");

index.js

@@ -1,2 +0,2 @@
-// Copyright (c) 2022 Micro Focus or one of its affiliates.
+// Copyright (c) 2022-2023 Micro Focus or one of its affiliates.
 //
@@ -22,3 +22,3 @@ // Licensed under the Apache License, Version 2.0 (the "License");
 //Original work Copyright (c) 2010-2014 Brian Carlson ([e-mail])
-//Modified work Copyright (c) 2022 Micro Focus or one of its affiliates.
+//Modified work Copyright (c) 2022-2023 Micro Focus or one of its affiliates.
 
@@ -25,0 +25,0 @@ //parses a connection string

package.json

 {
   "name": "v-connection-string",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Functions for dealing with a Vertica connection string",
@@ -5,0 +5,0 @@ "main": "./index.js",

README.md

@@ -7,3 +7,3 @@ # v-connection-string
 
-Enables using connection strings to establish connections with the vertica-nodejs driver
+Enables handling of connection strings to establish connections with the vertica-nodejs driver.
 
@@ -21,4 +21,17 @@ ## Documentation
 
+
+## Establishing a TCP Connection with Connection String
+
+The URL format for opening a TCP connection: 
+
+```javascript 
+vertica://<user>:<password>@<host>:<port>/<database>?configParams
+```
+
+where configParams are of the format ?parameterName=parameterValue and include other supported options outside of the required five. These config parameters will be passed through the same way as establishing a client connection with a config object. 
+
+Username and Password should be urlencoded, but the database name should not be urlencoded. 
+
 ## License
 
 Apache 2.0 License, please see [LICENSE](https://github.com/vertica/vertica-nodejs/blob/master/LICENSE) for details.

No alert changes

Improved metrics

Total package byte prevSize

6540

9.36%

Number of lines in readme file

36

56.52%

No dependency changes