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

ibm-cloud-sdk-core 4.0.7 → 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 (265) hide show

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

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

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

@@ -4,7 +4,7 @@
 ## CloudPakForDataAuthenticator.requiredOptions property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requiredOptions: string[];

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

@@ -4,7 +4,7 @@
 ## CloudPakForDataAuthenticator.tokenManager property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenManager: Cp4dTokenManager;

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

@@ -6,7 +6,7 @@
 Compute and return a Basic Authorization header from a username and password.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function computeBasicAuthHeader(username: string, password: string): string;
@@ -19,7 +19,7 @@ export declare function computeBasicAuthHeader(username: string, password: strin
 |  username | string | The username or client id |
 |  password | string | The password or client secret |
-<b>Returns:</b>
+**Returns:**
 string

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

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

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

@@ -6,7 +6,7 @@
 Constructs a service URL by formatting a parameterized URL.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function constructServiceUrl(parameterizedUrl: string, defaultUrlVariables: Map<string, string>, providedUrlVariables: Map<string, string> | null): string;
@@ -20,7 +20,7 @@ export declare function constructServiceUrl(parameterizedUrl: string, defaultUrl
 |  defaultUrlVariables | Map&lt;string, string&gt; | a Map of variable names to default values. Each variable in the parameterized URL must have a default value specified in this map. |
 |  providedUrlVariables | Map&lt;string, string&gt; \| null | a Map of variable names to desired values. If a variable is not provided in this map, the default variable value will be used instead. |
-<b>Returns:</b>
+**Returns:**
 string

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

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

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

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

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

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

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

@@ -6,7 +6,7 @@
 Setter for the filename of the compute resource token.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setCrTokenFilename(crTokenFilename: string): void;
@@ -18,7 +18,7 @@ setCrTokenFilename(crTokenFilename: string): void;
 |  --- | --- | --- |
 |  crTokenFilename | string | A string containing a path to the CR token file |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Setter for the "profile\_id" parameter to use when fetching the bearer token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileId(iamProfileId: string): void;
@@ -18,7 +18,7 @@ setIamProfileId(iamProfileId: string): void;
 |  --- | --- | --- |
 |  iamProfileId | string | the ID of the IAM trusted profile |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Setter for the "profile\_name" parameter to use when fetching the bearer token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileName(iamProfileName: string): void;
@@ -18,7 +18,7 @@ setIamProfileName(iamProfileName: string): void;
 |  --- | --- | --- |
 |  iamProfileName | string | the name of the IAM trusted profile |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -4,7 +4,7 @@
 ## ContainerAuthenticator.tokenManager property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected tokenManager: ContainerTokenManager;

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

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

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

@@ -6,12 +6,12 @@
 Retrieves the CR token from a file using this search order: 1. User-specified filename (if specified) 2. Default file \#1 (/var/run/secrets/tokens/vault-token) 3. Default file \#2 (/var/run/secrets/tokens/sa-token) First one found wins.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected getCrToken(): string;
 ```
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -6,12 +6,12 @@
 The ContainerTokenManager retrieves a compute resource token from a file on the container. This token is used to perform the necessary interactions with the IAM token service to obtain and store a suitable bearer (access) token.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class ContainerTokenManager extends IamRequestBasedTokenManager
 ```
-<b>Extends:</b> [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
+**Extends:** [IamRequestBasedTokenManager](./ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md)
 ## Constructors

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

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

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

@@ -6,7 +6,7 @@
 Sets the "crTokenFilename" field
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setCrTokenFilename(crTokenFilename: string): void;
@@ -18,7 +18,7 @@ setCrTokenFilename(crTokenFilename: string): void;
 |  --- | --- | --- |
 |  crTokenFilename | string | the name of the file containing the CR token |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Sets the ID of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileId(iamProfileId: string): void;
@@ -18,7 +18,7 @@ setIamProfileId(iamProfileId: string): void;
 |  --- | --- | --- |
 |  iamProfileId | string | the ID of the IAM trusted profile |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -6,7 +6,7 @@
 Sets the name of the IAM trusted profile to use when obtaining an access token from the IAM token server.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 setIamProfileName(iamProfileName: string): void;
@@ -18,7 +18,7 @@ setIamProfileName(iamProfileName: string): void;
 |  --- | --- | --- |
 |  iamProfileName | string | the name of the IAM trusted profile |
-<b>Returns:</b>
+**Returns:**
 void

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

@@ -4,7 +4,7 @@
 ## contentType variable
-<b>Signature:</b>
+**Signature:**
 ```typescript
 _default: {

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

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

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

@@ -8,12 +8,12 @@ Token Manager of CloudPak for data.
 The Token Manager performs basic auth with a username and password to acquire CP4D tokens.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare class Cp4dTokenManager extends JwtTokenManager
 ```
-<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
+**Extends:** [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
 ## Constructors

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

@@ -4,12 +4,12 @@
 ## Cp4dTokenManager.requestToken() method
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requestToken(): Promise<any>;
 ```
-<b>Returns:</b>
+**Returns:**
 Promise&lt;any&gt;

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

@@ -4,7 +4,7 @@
 ## Cp4dTokenManager.requiredOptions property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 protected requiredOptions: string[];

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

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

package/build/docs/ibm-cloud-sdk-core.fileobject.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
 export interface FileObject
@@ -22,6 +22,6 @@ export interface FileObject
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [options?](./ibm-cloud-sdk-core.fileobject.options.md) |  | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | <i>(Optional)</i> |
+|  [options?](./ibm-cloud-sdk-core.fileobject.options.md) |  | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | _(Optional)_ |
 |  [value](./ibm-cloud-sdk-core.fileobject.value.md) |  | NodeJS.ReadableStream \| Buffer \| string |  |

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

@@ -4,7 +4,7 @@
 ## FileObject.options property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 options?: FileOptions;

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

@@ -4,7 +4,7 @@
 ## FileObject.value property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 value: NodeJS.ReadableStream | Buffer | string;

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

@@ -4,7 +4,7 @@
 ## FileOptions.contentType property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 contentType?: string;

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

@@ -4,7 +4,7 @@
 ## FileOptions.filename property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 filename?: string;

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

@@ -4,7 +4,7 @@
 ## FileOptions interface
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export interface FileOptions
@@ -14,6 +14,6 @@ export interface FileOptions
 |  Property | Modifiers | Type | Description |
 |  --- | --- | --- | --- |
-|  [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) |  | string | <i>(Optional)</i> |
-|  [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) |  | string | <i>(Optional)</i> |
+|  [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) |  | string | _(Optional)_ |
+|  [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) |  | string | _(Optional)_ |

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

@@ -4,12 +4,12 @@
 ## FileStream interface
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export interface FileStream extends NodeJS.ReadableStream
 ```
-<b>Extends:</b> NodeJS.ReadableStream
+**Extends:** NodeJS.ReadableStream
 ## Properties

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

@@ -4,7 +4,7 @@
 ## FileStream.path property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 path: string | Buffer;

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

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

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

@@ -4,7 +4,7 @@
 ## FileWithMetadata.data property
-<b>Signature:</b>
+**Signature:**
 ```typescript
 data: NodeJS.ReadableStream | Buffer;

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

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

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

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

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

@@ -8,7 +8,7 @@ Look for external configuration of authenticator.
 Try to get authenticator from external sources, with the following priority: 1. Credentials file (ibm-credentials.env) 2. Environment variables 3. VCAP Services (Cloud Foundry)
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
@@ -20,7 +20,7 @@ export declare function getAuthenticatorFromEnvironment(serviceName: string): Au
 |  --- | --- | --- |
 |  serviceName | string | the service name prefix. |
-<b>Returns:</b>
+**Returns:**
 [Authenticator](./ibm-cloud-sdk-core.authenticator.md)

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

@@ -6,7 +6,7 @@
 This function retrieves the content type of the input.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
@@ -18,7 +18,7 @@ export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer
 |  --- | --- | --- |
 |  inputData | NodeJS.ReadableStream \| Buffer | The data to retrieve content type for. |
-<b>Returns:</b>
+**Returns:**
 Promise&lt;string&gt;

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

@@ -6,12 +6,12 @@
 Gets the current time.
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getCurrentTime(): number;
 ```
-<b>Returns:</b>
+**Returns:**
 number

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

@@ -6,7 +6,7 @@
 Returns the first match from formats that is key the params map otherwise null
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getFormat(params: {
@@ -21,7 +21,7 @@ export declare function getFormat(params: {
 |  params | { \[key: string\]: any; } | The parameters. |
 |  formats | string\[\] |  |
-<b>Returns:</b>
+**Returns:**
 string

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

@@ -6,7 +6,7 @@
 Validates that all required params are provided
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getMissingParams(params: {
@@ -21,7 +21,7 @@ export declare function getMissingParams(params: {
 |  params | { \[key: string\]: any; } | the method parameters. |
 |  requires | string\[\] | the required parameter names. |
-<b>Returns:</b>
+**Returns:**
 null \| Error

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

@@ -10,7 +10,7 @@ The logger will be an instance of the `debug` package and utilizes its support f
 Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios".
-<b>Signature:</b>
+**Signature:**
 ```typescript
 export declare function getNewLogger(moduleName: string): SDKLogger;
@@ -22,7 +22,7 @@ export declare function getNewLogger(moduleName: string): SDKLogger;
 |  --- | --- | --- |
 |  moduleName | string | the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level. |
-<b>Returns:</b>
+**Returns:**
 [SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)