ibm-cloud-sdk-core - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

auth/authenticators/authenticator-interface.d.ts

@@ -41,3 +41,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
@@ -44,0 +44,0 @@ * Returns a string that indicates the authentication type.

auth/authenticators/authenticator.d.ts

@@ -49,3 +49,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
@@ -52,0 +52,0 @@ * Retrieves the authenticator's type.

auth/authenticators/basic-authenticator.d.ts

@@ -58,3 +58,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
@@ -61,0 +61,0 @@ * Returns the authenticator's type ('basic').

auth/authenticators/token-request-based-authenticator.d.ts

@@ -90,3 +90,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 }

build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md

@@ -12,3 +12,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
@@ -24,3 +24,3 @@
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 
@@ -27,0 +27,0 @@ ## Exceptions

build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md

@@ -12,3 +12,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
@@ -24,3 +24,3 @@
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 

build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md

@@ -14,3 +14,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
@@ -26,3 +26,3 @@
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 

build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md

@@ -14,3 +14,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 ```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 ```
@@ -26,3 +26,3 @@
 
-Promise&lt;void \| Error&gt;
+Promise&lt;void&gt;
 

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [3.0.1](https://github.com/IBM/node-sdk-core/compare/v3.0.0...v3.0.1) (2022-07-28)
+
+
+### Bug Fixes
+
+* correct AuthenticatorInterface type ([#206](https://github.com/IBM/node-sdk-core/issues/206)) ([31dc7bd](https://github.com/IBM/node-sdk-core/commit/31dc7bd1e744a071cdabc2b5bf1e9513024079ac)), closes [#176](https://github.com/IBM/node-sdk-core/issues/176)
+
 # [3.0.0](https://github.com/IBM/node-sdk-core/compare/v2.17.15...v3.0.0) (2022-07-28)
@@ -2,0 +9,0 @@

es/auth/authenticators/authenticator-interface.d.ts

@@ -41,3 +41,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
@@ -44,0 +44,0 @@ * Returns a string that indicates the authentication type.

es/auth/authenticators/authenticator.d.ts

@@ -49,3 +49,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
@@ -52,0 +52,0 @@ * Retrieves the authenticator's type.

es/auth/authenticators/basic-authenticator.d.ts

@@ -58,3 +58,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     /**
@@ -61,0 +61,0 @@ * Returns the authenticator's type ('basic').

es/auth/authenticators/token-request-based-authenticator.d.ts

@@ -90,3 +90,3 @@ /**
      */
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 }

etc/ibm-cloud-sdk-core.api.md

@@ -24,3 +24,3 @@ ## API Report File for "ibm-cloud-sdk-core"
     // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -46,3 +46,3 @@ static AUTHTYPE_BASIC: string;
 export interface AuthenticatorInterface {
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -77,3 +77,3 @@ }
     constructor(options: Options);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -396,3 +396,3 @@ // (undocumented)
     constructor(options: BaseOptions);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     // (undocumented)
@@ -399,0 +399,0 @@ protected disableSslVerification: boolean;

package.json

 {
   "name": "ibm-cloud-sdk-core",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "Core functionality to support SDKs generated with IBM's OpenAPI SDK Generator.",
@@ -5,0 +5,0 @@ "main": "index.js",

temp/ibm-cloud-sdk-core.api.md

@@ -24,3 +24,3 @@ ## API Report File for "ibm-cloud-sdk-core"
     // Warning: (ae-forgotten-export) The symbol "AuthenticateOptions" needs to be exported by the entry point index.d.ts
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -46,3 +46,3 @@ static AUTHTYPE_BASIC: string;
 export interface AuthenticatorInterface {
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -77,3 +77,3 @@ }
     constructor(options: Options);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     authenticationType(): string;
@@ -396,3 +396,3 @@ // (undocumented)
     constructor(options: BaseOptions);
-    authenticate(requestOptions: AuthenticateOptions): Promise<void | Error>;
+    authenticate(requestOptions: AuthenticateOptions): Promise<void>;
     // (undocumented)
@@ -399,0 +399,0 @@ protected disableSslVerification: boolean;

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

Worsened metrics

Total package byte prevSize

1423597

decreased by-0.15%

Lines of code

28061

decreased by-0.26%

No dependency changes