npm - ibm-cloud-sdk-core - Versions diffs - 4.3.0 → 4.3.2-beta - Mend

ibm-cloud-sdk-core 4.3.0 → 4.3.2-beta

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

package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.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; [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) &gt; [contentType](./ibm-cloud-sdk-core.fileoptions.contenttype.md)
-## FileOptions.contentType property
-**Signature:**
-```typescript
-contentType?: string;
-```

package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.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; [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) &gt; [filename](./ibm-cloud-sdk-core.fileoptions.filename.md)
-## FileOptions.filename property
-**Signature:**
-```typescript
-filename?: string;
-```

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

@@ -1,74 +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; [FileOptions](./ibm-cloud-sdk-core.fileoptions.md)
-## FileOptions interface
-**Signature:**
-```typescript
-export interface FileOptions
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md)
-</td><td>
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[filename?](./ibm-cloud-sdk-core.fileoptions.filename.md)
-</td><td>
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>

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

@@ -1,54 +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; [FileStream](./ibm-cloud-sdk-core.filestream.md)
-## FileStream interface
-**Signature:**
-```typescript
-export interface FileStream extends NodeJS.ReadableStream
-```
-**Extends:** NodeJS.ReadableStream
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[path](./ibm-cloud-sdk-core.filestream.path.md)
-</td><td>
-</td><td>
-string \| Buffer
-</td><td>
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.filestream.path.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; [FileStream](./ibm-cloud-sdk-core.filestream.md) &gt; [path](./ibm-cloud-sdk-core.filestream.path.md)
-## FileStream.path property
-**Signature:**
-```typescript
-path: string | Buffer;
-```

package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) &gt; [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md)
-## FileWithMetadata.contentType property
-**Signature:**
-```typescript
-contentType: string;
-```

package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) &gt; [data](./ibm-cloud-sdk-core.filewithmetadata.data.md)
-## FileWithMetadata.data property
-**Signature:**
-```typescript
-data: NodeJS.ReadableStream | Buffer;
-```

package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) &gt; [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md)
-## FileWithMetadata.filename property
-**Signature:**
-```typescript
-filename: string;
-```

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

@@ -1,87 +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; [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
-## FileWithMetadata interface
-**Signature:**
-```typescript
-export interface FileWithMetadata
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[data](./ibm-cloud-sdk-core.filewithmetadata.data.md)
-</td><td>
-</td><td>
-NodeJS.ReadableStream \| Buffer
-</td><td>
-</td></tr>
-<tr><td>
-[filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md)
-</td><td>
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.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; [getAuthenticatorFromEnvironment](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md)
-## getAuthenticatorFromEnvironment() function
-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)
-**Signature:**
-```typescript
-export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
-```
-## 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:**
-[Authenticator](./ibm-cloud-sdk-core.authenticator.md)

package/build/docs/ibm-cloud-sdk-core.getcontenttype.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; [getContentType](./ibm-cloud-sdk-core.getcontenttype.md)
-## getContentType() function
-This function retrieves the content type of the input.
-**Signature:**
-```typescript
-export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-inputData
-</td><td>
-NodeJS.ReadableStream \| Buffer
-</td><td>
-The data to retrieve content type for.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;string&gt;
-the content type of the input.

package/build/docs/ibm-cloud-sdk-core.getcurrenttime.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; [getCurrentTime](./ibm-cloud-sdk-core.getcurrenttime.md)
-## getCurrentTime() function
-Gets the current time.
-**Signature:**
-```typescript
-export declare function getCurrentTime(): number;
-```
-**Returns:**
-number
-the current time in seconds.

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

@@ -1,69 +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; [getFormat](./ibm-cloud-sdk-core.getformat.md)
-## getFormat() function
-Returns the first match from formats that is key the params map otherwise null
-**Signature:**
-```typescript
-export declare function getFormat(params: {
-    [key: string]: any;
-}, formats: string[]): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-params
-</td><td>
-{ \[key: string\]: any; }
-</td><td>
-The parameters.
-</td></tr>
-<tr><td>
-formats
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-string

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

@@ -1,73 +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; [getMissingParams](./ibm-cloud-sdk-core.getmissingparams.md)
-## getMissingParams() function
-Validates that all required params are provided
-**Signature:**
-```typescript
-export declare function getMissingParams(params: {
-    [key: string]: any;
-}, requires: string[]): null | Error;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-params
-</td><td>
-{ \[key: string\]: any; }
-</td><td>
-the method parameters.
-</td></tr>
-<tr><td>
-requires
-</td><td>
-string\[\]
-</td><td>
-the required parameter names.
-</td></tr>
-</tbody></table>
-**Returns:**
-null \| Error
-null if no errors found, otherwise an Error instance

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

@@ -1,59 +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; [getNewLogger](./ibm-cloud-sdk-core.getnewlogger.md)
-## getNewLogger() function
-Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`<!-- -->, `warn`<!-- -->, `info`<!-- -->, `verbose`<!-- -->, and `debug`<!-- -->.
-The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.
-Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios".
-**Signature:**
-```typescript
-export declare function getNewLogger(moduleName: string): SDKLogger;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-moduleName
-</td><td>
-string
-</td><td>
-the namespace for the logger. The name will appear in the logs and it will be the name used for configuring the log level.
-</td></tr>
-</tbody></table>
-**Returns:**
-[SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
-the new logger

package/build/docs/ibm-cloud-sdk-core.getqueryparam.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; [getQueryParam](./ibm-cloud-sdk-core.getqueryparam.md)
-## getQueryParam() function
-Return a query parameter value from a URL
-**Signature:**
-```typescript
-export declare function getQueryParam(urlStr: string, param: string): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-urlStr
-</td><td>
-string
-</td><td>
-the url string.
-</td></tr>
-<tr><td>
-param
-</td><td>
-string
-</td><td>
-the name of the query parameter whose value should be returned
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-the value of the "param" query parameter