npm - ibm-cloud-sdk-core - Versions diffs - 4.0.6 → 4.0.8 - Mend

ibm-cloud-sdk-core 4.0.6 → 4.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (275) hide show

package/build/docs/ibm-cloud-sdk-core.isjsonmimetype.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Returns true if and only if "mimeType" is a "JSON-like" mime type (e.g. "application/json; charset=utf-8").
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function isJsonMimeType(mimeType: string): boolean;
@@ -18,7 +18,7 @@ export declare function isJsonMimeType(mimeType: string): boolean;
 |  --- | --- | --- |
 |  mimeType | string | the mimeType string |
-<b>Returns:</b>
+**Returns:**
 boolean

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new JwtTokenManager instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: JwtTokenManagerOptions);

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md CHANGED Viewed

@@ -6,12 +6,12 @@
 A class for shared functionality for parsing, storing, and requesting JWT tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement `requestToken()` to retrieve the bearer token from intended sources.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class JwtTokenManager extends TokenManager
 ```
-<b>Extends:</b> [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md)
+**Extends:** [TokenManager](./ibm-cloud-sdk-core.tokenmanager.md)
 ## Constructors

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Request a JWT using an API key.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Save the JWT service response and the calculated expiration time to the object's state.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected saveTokenInfo(tokenResponse: any): void;
@@ -18,7 +18,7 @@ protected saveTokenInfo(tokenResponse: any): void;
 |  --- | --- | --- |
 |  tokenResponse | any | the response object from JWT service request |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## JwtTokenManager.tokenInfo property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenInfo: any;

package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## JwtTokenManager.tokenName property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenName: string;

package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md CHANGED Viewed

@@ -6,10 +6,10 @@
 Configuration options for JWT token retrieval.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export type JwtTokenManagerOptions = TokenManagerOptions;
 ```
-<b>References:</b> [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)
+**References:** [TokenManagerOptions](./ibm-cloud-sdk-core.tokenmanageroptions.md)

package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## NoAuthAuthenticator.authenticate() method
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticate(requestOptions: AuthenticateOptions): Promise<void>;
@@ -16,7 +16,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 |  --- | --- | --- |
 |  requestOptions | AuthenticateOptions |  |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;void&gt;

package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Returns the authenticator's type ('noauth').
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticationType(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.md CHANGED Viewed

@@ -6,12 +6,12 @@
 NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class NoAuthAuthenticator extends Authenticator
 ```
-<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+**Extends:** [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
 ## Methods

package/build/docs/ibm-cloud-sdk-core.onlyone.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Checks for only one of two elements being defined. Returns true if a is defined and b is undefined, or vice versa. Returns false if both are defined or both are undefined.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function onlyOne(a: any, b: any): boolean;
@@ -19,7 +19,7 @@ export declare function onlyOne(a: any, b: any): boolean;
 |  a | any | The first object |
 |  b | any | The second object |
-<b>Returns:</b>
+**Returns:**
 boolean

package/build/docs/ibm-cloud-sdk-core.qs.md CHANGED Viewed

@@ -12,7 +12,7 @@ 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.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 _default: {

package/build/docs/ibm-cloud-sdk-core.readcredentialsfile.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`<!-- -->.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function readCredentialsFile(): any;
 ```
-<b>Returns:</b>
+**Returns:**
 any

package/build/docs/ibm-cloud-sdk-core.readcrtokenfile.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## readCrTokenFile() function
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function readCrTokenFile(filepath: string): string;
@@ -16,7 +16,7 @@ export declare function readCrTokenFile(filepath: string): string;
 |  --- | --- | --- |
 |  filepath | string |  |
-<b>Returns:</b>
+**Returns:**
 string

package/build/docs/ibm-cloud-sdk-core.readexternalsources.md CHANGED Viewed

@@ -8,7 +8,7 @@ Read properties stored in external sources like Environment Variables, the crede
 Only one source will be used at a time.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function readExternalSources(serviceName: string): any;
@@ -20,7 +20,7 @@ export declare function readExternalSources(serviceName: string): any;
 |  --- | --- | --- |
 |  serviceName | string | the service name prefix |
-<b>Returns:</b>
+**Returns:**
 any

package/build/docs/ibm-cloud-sdk-core.removesuffix.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Removes a given suffix if it exists.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function removeSuffix(str: string, suffix: string): string;
@@ -19,7 +19,7 @@ export declare function removeSuffix(str: string, suffix: string): string;
 |  str | string | the base string to operate on |
 |  suffix | string | the suffix to remove, if present |
-<b>Returns:</b>
+**Returns:**
 string

package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## SDKLogger.debug property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 debug: Debugger;

package/build/docs/ibm-cloud-sdk-core.sdklogger.error.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## SDKLogger.error property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 error: Debugger;

package/build/docs/ibm-cloud-sdk-core.sdklogger.info.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## SDKLogger.info property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 info: Debugger;

package/build/docs/ibm-cloud-sdk-core.sdklogger.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## SDKLogger interface
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export interface SDKLogger

package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## SDKLogger.verbose property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 verbose: Debugger;

package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## SDKLogger.warn property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 warn: Debugger;

package/build/docs/ibm-cloud-sdk-core.streamtopromise.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Helper method that can be bound to a stream - it captures all of the results, and returns a promise that resolves to the final buffer or array of text chunks Essentially a smaller version of concat-stream wrapped in a promise
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function streamToPromise(stream: Stream): Promise<any>;
@@ -18,7 +18,7 @@ export declare function streamToPromise(stream: Stream): Promise<any>;
 |  --- | --- | --- |
 |  stream | Stream | optional stream param for when not bound to an existing stream instance. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Strips trailing slashes from "url", if present.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function stripTrailingSlash(url: string): string;
@@ -18,7 +18,7 @@ export declare function stripTrailingSlash(url: string): string;
 |  --- | --- | --- |
 |  url | string | the url string |
-<b>Returns:</b>
+**Returns:**
 string

package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new TokenManager instance.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: TokenManagerOptions);

package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.accessToken property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected accessToken: string;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.disableSslVerification property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected disableSslVerification: boolean;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.expireTime property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected expireTime: number;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Retrieves a new token using "requestToken()" if there is not a currently stored token from a previous call, or the previous token has expired.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 getToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.headers property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected headers: OutgoingHttpHeaders;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.md CHANGED Viewed

@@ -6,7 +6,7 @@
 A class for shared functionality for storing, and requesting tokens. Intended to be used as a parent to be extended for token request management. Child classes should implement "requestToken()" to retrieve the token from intended sources and "saveTokenInfo(tokenResponse)" to parse and save token information from the response.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class TokenManager

package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md CHANGED Viewed

@@ -8,12 +8,12 @@ Paces requests to requestToken().
 This method pseudo-serializes requests for an access\_token when the current token is undefined or expired. The first caller to this method records its `requestTime` and then issues the token request. Subsequent callers will check the `requestTime` to see if a request is active (has been issued within the past 60 seconds), and if so will queue their promise for the active requestor to resolve when that request completes.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected pacedRequestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.refreshTime property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected refreshTime: number;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md CHANGED Viewed

@@ -6,12 +6,12 @@
 Request a token using an API endpoint.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.requestWrapperInstance property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestWrapperInstance: RequestWrapper;

package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Parse and save token information from the response. Save the requested token into field `accessToken`<!-- -->. Calculate expiration and refresh time from the received info and store them in fields `expireTime` and `refreshTime`<!-- -->.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected saveTokenInfo(tokenResponse: any): void;
@@ -18,7 +18,7 @@ protected saveTokenInfo(tokenResponse: any): void;
 |  --- | --- | --- |
 |  tokenResponse | any | the response object from a token service request |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Sets the "disableSslVerification" property.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setDisableSslVerification(value: boolean): void;
@@ -18,7 +18,7 @@ setDisableSslVerification(value: boolean): void;
 |  --- | --- | --- |
 |  value | boolean | the new value for the disableSslVerification property |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Sets the headers to be included with each outbound request to the token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setHeaders(headers: OutgoingHttpHeaders): void;
@@ -18,7 +18,7 @@ setHeaders(headers: OutgoingHttpHeaders): void;
 |  --- | --- | --- |
 |  headers | OutgoingHttpHeaders | the set of headers to send with each request to the token server |
-<b>Returns:</b>
+**Returns:**
 void

package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenManager.url property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected url: string;

package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Configuration options for token retrieval.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export type TokenManagerOptions = {

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Create a new TokenRequestBasedAuthenticator instance with an internal JwtTokenManager.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 constructor(options: BaseOptions);

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

@@ -8,7 +8,7 @@ Adds bearer token information to "requestOptions". The bearer token information
 Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 authenticate(requestOptions: AuthenticateOptions): Promise<void>;
@@ -20,7 +20,7 @@ authenticate(requestOptions: AuthenticateOptions): Promise<void>;
 |  --- | --- | --- |
 |  requestOptions | AuthenticateOptions | The request to augment with authentication information. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;void&gt;

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenRequestBasedAuthenticator.disableSslVerification property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected disableSslVerification: boolean;

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md CHANGED Viewed

@@ -4,7 +4,7 @@
 ## TokenRequestBasedAuthenticator.headers property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected headers: OutgoingHttpHeaders;

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md CHANGED Viewed

@@ -10,12 +10,12 @@ The token will be added as an Authorization header in the form:
 Authorization: Bearer &lt;<!-- -->bearer-token<!-- -->&gt;
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class TokenRequestBasedAuthenticator extends Authenticator
 ```
-<b>Extends:</b> [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
+**Extends:** [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
 ## Constructors

package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md CHANGED Viewed

@@ -6,7 +6,7 @@
 Set the flag that indicates whether verification of the server's SSL certificate should be disabled or not.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setDisableSslVerification(value: boolean): void;
@@ -18,7 +18,7 @@ setDisableSslVerification(value: boolean): void;
 |  --- | --- | --- |
 |  value | boolean | a flag that indicates whether verification of the token server's SSL certificate should be disabled or not. |
-<b>Returns:</b>
+**Returns:**
 void