argsclopts - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

CHANGELOG.md

@@ -10,6 +10,12 @@ # Changelog
 
-## [v1.0.2](https://github.com/bcomnes/argsclopts/compare/v1.0.1...v1.0.2)
+## [v1.0.3](https://github.com/bcomnes/argsclopts/compare/v1.0.2...v1.0.3)
 
 ### Commits
 
+- Fix types [`8455453`](https://github.com/bcomnes/argsclopts/commit/8455453e10e403c2757ab25ef8bbf542bd179874)
+
+## [v1.0.2](https://github.com/bcomnes/argsclopts/compare/v1.0.1...v1.0.2) - 2023-12-28
+
+### Commits
+
 - Improve docs, finalize api [`98e74af`](https://github.com/bcomnes/argsclopts/commit/98e74af5ef161f1868362bb912bd6e4fe9bd1f21)
@@ -16,0 +22,0 @@

index.d.ts

@@ -7,3 +7,3 @@ export function usage(options: ArgscloptsParseArgsOptionsConfig): string;
 export function header({ pkgPath, name, headerFn, exampleFn }: {
-    pkgPath: string;
+    pkgPath?: string | undefined;
     name?: string | undefined;
@@ -14,3 +14,3 @@ headerFn?: FormatterFunction | undefined;
 export function footer({ pkgPath, name, version, footerFn }: {
-    pkgPath: string;
+    pkgPath?: string | undefined;
     name?: string | undefined;
@@ -21,4 +21,4 @@ version?: string | undefined;
 export function formatHelpText({ options, pkgPath, name, version, footerFn, headerFn, exampleFn }: {
-    pkgPath: string;
     options: ArgscloptsParseArgsOptionsConfig;
+    pkgPath?: string | undefined;
     name?: string | undefined;
@@ -31,4 +31,4 @@ version?: string | undefined;
 export function printHelpText({ options, pkgPath, name, version, footerFn, headerFn, exampleFn }: {
-    pkgPath: string;
     options: ArgscloptsParseArgsOptionsConfig;
+    pkgPath?: string | undefined;
     name?: string | undefined;
@@ -35,0 +35,0 @@ version?: string | undefined;

index.js

@@ -84,3 +84,3 @@ import { readFile } from 'node:fs/promises'
  * @param {Object} params - The parameters object.
- * @param {string} params.pkgPath - The path to the package file. Used to determine the package name if 'name' is not provided.
+ * @param {string} [params.pkgPath] - The path to the package file. Used to determine the package name if 'name' is not provided.
  * @param {string} [params.name] - The name to be used in the header. If not provided, it's extracted from the package file at 'pkgPath'.
@@ -121,3 +121,3 @@ * @param {FormatterFunction} [params.headerFn] - A function that returns the usage string.
  * @param {Object} params - The parameters object.
- * @param {string} params.pkgPath - The path to the package file. Used to determine the package name if 'name' is not provided.
+ * @param {string} [params.pkgPath] - The path to the package file. Used to determine the package name if 'name' is not provided.
  * @param {string} [params.name] - The name to be used in the header. If not provided, it's extracted from the package file at 'pkgPath'.
@@ -157,4 +157,4 @@ * @param {string} [params.version] - The version to be used in the footer. If not provided, it's extracted from the package file at 'pkgPath'.
  * @param {Object} params
- * @param {string} params.pkgPath - The path to a package.json.
  * @param {ArgscloptsParseArgsOptionsConfig} params.options - Options matching the config.options shape in util.parseArgs
+ * @param {string} [params.pkgPath] - The path to a package.json.
  * @param {string} [params.name] - The bin name
@@ -192,4 +192,4 @@ * @param {string} [params.version] - The bin version
  * @param {Object} params
- * @param {string} params.pkgPath - The path to a package.json.
  * @param {ArgscloptsParseArgsOptionsConfig} params.options - Options matching the config.options shape in util.parseArgs
+ * @param {string} [params.pkgPath] - The path to a package.json.
  * @param {string} [params.name] - The bin name
@@ -196,0 +196,0 @@ * @param {string} [params.version] - The bin version

package.json

 {
   "name": "argsclopts",
   "description": "cliclopts but for Node.js parseArgs",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "author": "Bret Comnes <[e-mail]> (https://bret.io)",
@@ -6,0 +6,0 @@ "bugs": {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

24845

increased by0.93%

No dependency changes