npm - ibm-cloud-sdk-core - Versions diffs - 5.0.0 → 5.0.2 - Mend

ibm-cloud-sdk-core 5.0.0 → 5.0.2

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 (256) hide show

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

@@ -1,49 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) &gt; [authenticate](./ibm-cloud-sdk-core.noauthauthenticator.authenticate.md)
-## NoAuthAuthenticator.authenticate() method
-**Signature:**
-```typescript
-authenticate(requestOptions: AuthenticateOptions): Promise<void>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-requestOptions
-</td><td>
-AuthenticateOptions
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;void&gt;

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md) &gt; [authenticationType](./ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md)
-## NoAuthAuthenticator.authenticationType() method
-Returns the authenticator's type ('noauth').
-**Signature:**
-```typescript
-authenticationType(): string;
-```
-**Returns:**
-string
-a string that indicates the authenticator's type

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

@@ -1,60 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [NoAuthAuthenticator](./ibm-cloud-sdk-core.noauthauthenticator.md)
-## NoAuthAuthenticator class
-NoAuthAuthenticator is a placeholder authenticator implementation which performs no authentication of outgoing REST API requests. It might be useful during development and testing.
-**Signature:**
-```typescript
-export declare class NoAuthAuthenticator extends Authenticator
-```
-**Extends:** [Authenticator](./ibm-cloud-sdk-core.authenticator.md)
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authenticate(requestOptions)](./ibm-cloud-sdk-core.noauthauthenticator.authenticate.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[authenticationType()](./ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md)
-</td><td>
-</td><td>
-Returns the authenticator's type ('noauth').
-</td></tr>
-</tbody></table>

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

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [onlyOne](./ibm-cloud-sdk-core.onlyone.md)
-## onlyOne() function
-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.
-**Signature:**
-```typescript
-export declare function onlyOne(a: any, b: any): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-a
-</td><td>
-any
-</td><td>
-The first object
-</td></tr>
-<tr><td>
-b
-</td><td>
-any
-</td><td>
-The second object
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean
-true if and only if exactly one of a or b is defined

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

@@ -1,21 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [qs](./ibm-cloud-sdk-core.qs.md)
-## qs variable
-(C) Copyright IBM Corp. 2019, 2022.
-Licensed 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.
-**Signature:**
-```typescript
-_default: {
-    stringify: (queryParams: Object) => string;
-}
-```

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

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [readCredentialsFile](./ibm-cloud-sdk-core.readcredentialsfile.md)
-## readCredentialsFile() function
-Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`<!-- -->.
-**Signature:**
-```typescript
-export declare function readCredentialsFile(): any;
-```
-**Returns:**
-any

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

@@ -1,49 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [readCrTokenFile](./ibm-cloud-sdk-core.readcrtokenfile.md)
-## readCrTokenFile() function
-**Signature:**
-```typescript
-export declare function readCrTokenFile(filepath: string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-filepath
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string

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

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [readExternalSources](./ibm-cloud-sdk-core.readexternalsources.md)
-## readExternalSources() function
-Read properties stored in external sources like Environment Variables, the credentials file, VCAP services, etc. and return them as an object. The keys of this object will have the service name prefix removed and will be converted to lower camel case.
-Only one source will be used at a time.
-**Signature:**
-```typescript
-export declare function readExternalSources(serviceName: string): any;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-serviceName
-</td><td>
-string
-</td><td>
-the service name prefix
-</td></tr>
-</tbody></table>
-**Returns:**
-any

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

@@ -1,71 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [removeSuffix](./ibm-cloud-sdk-core.removesuffix.md)
-## removeSuffix() function
-Removes a given suffix if it exists.
-**Signature:**
-```typescript
-export declare function removeSuffix(str: string, suffix: string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-str
-</td><td>
-string
-</td><td>
-the base string to operate on
-</td></tr>
-<tr><td>
-suffix
-</td><td>
-string
-</td><td>
-the suffix to remove, if present
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-the substring of "str" that remains after the suffix is removed

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [debug](./ibm-cloud-sdk-core.sdklogger.debug.md)
-## SDKLogger.debug property
-**Signature:**
-```typescript
-debug: Debugger;
-```

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [error](./ibm-cloud-sdk-core.sdklogger.error.md)
-## SDKLogger.error property
-**Signature:**
-```typescript
-error: Debugger;
-```

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [info](./ibm-cloud-sdk-core.sdklogger.info.md)
-## SDKLogger.info property
-**Signature:**
-```typescript
-info: Debugger;
-```

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

@@ -1,121 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
-## SDKLogger interface
-**Signature:**
-```typescript
-export interface SDKLogger
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[debug](./ibm-cloud-sdk-core.sdklogger.debug.md)
-</td><td>
-</td><td>
-Debugger
-</td><td>
-</td></tr>
-<tr><td>
-[error](./ibm-cloud-sdk-core.sdklogger.error.md)
-</td><td>
-</td><td>
-Debugger
-</td><td>
-</td></tr>
-<tr><td>
-[info](./ibm-cloud-sdk-core.sdklogger.info.md)
-</td><td>
-</td><td>
-Debugger
-</td><td>
-</td></tr>
-<tr><td>
-[verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md)
-</td><td>
-</td><td>
-Debugger
-</td><td>
-</td></tr>
-<tr><td>
-[warn](./ibm-cloud-sdk-core.sdklogger.warn.md)
-</td><td>
-</td><td>
-Debugger
-</td><td>
-</td></tr>
-</tbody></table>

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [verbose](./ibm-cloud-sdk-core.sdklogger.verbose.md)
-## SDKLogger.verbose property
-**Signature:**
-```typescript
-verbose: Debugger;
-```

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md) &gt; [warn](./ibm-cloud-sdk-core.sdklogger.warn.md)
-## SDKLogger.warn property
-**Signature:**
-```typescript
-warn: Debugger;
-```

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

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [streamToPromise](./ibm-cloud-sdk-core.streamtopromise.md)
-## streamToPromise() function
-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
-**Signature:**
-```typescript
-export declare function streamToPromise(stream: Stream): Promise<any>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-stream
-</td><td>
-Stream
-</td><td>
-optional stream param for when not bound to an existing stream instance.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;any&gt;
-Promise