ibm-cloud-sdk-core 3.2.1 → 3.2.2-beta-1
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.
- package/auth/authenticators/authenticator.js +1 -0
- package/auth/authenticators/basic-authenticator.js +7 -4
- package/auth/authenticators/bearer-token-authenticator.js +7 -4
- package/auth/authenticators/cloud-pak-for-data-authenticator.js +4 -1
- package/auth/authenticators/container-authenticator.js +4 -1
- package/auth/authenticators/iam-authenticator.js +5 -2
- package/auth/authenticators/iam-request-based-authenticator.js +4 -1
- package/auth/authenticators/index.js +11 -10
- package/auth/authenticators/no-auth-authenticator.js +4 -1
- package/auth/authenticators/token-request-based-authenticator.js +6 -3
- package/auth/authenticators/vpc-instance-authenticator.js +4 -1
- package/auth/index.js +17 -6
- package/auth/token-managers/container-token-manager.js +7 -4
- package/auth/token-managers/cp4d-token-manager.js +6 -3
- package/auth/token-managers/iam-request-based-token-manager.js +9 -6
- package/auth/token-managers/iam-token-manager.js +5 -2
- package/auth/token-managers/index.js +8 -7
- package/auth/token-managers/jwt-token-manager.js +5 -2
- package/auth/token-managers/token-manager.js +5 -4
- package/auth/token-managers/vpc-instance-token-manager.js +11 -8
- package/auth/utils/file-reading-helpers.browser.js +1 -0
- package/auth/utils/file-reading-helpers.js +12 -11
- package/auth/utils/get-authenticator-from-environment.js +3 -2
- package/auth/utils/helpers.js +5 -4
- package/auth/utils/index.js +19 -7
- package/auth/utils/read-external-sources.js +6 -5
- package/es/auth/authenticators/authenticator-interface.js +1 -0
- package/es/lib/request-wrapper.js +13 -5
- package/index.js +32 -12
- package/lib/base-service.js +7 -6
- package/lib/content-type.js +1 -1
- package/lib/get-new-logger.js +6 -5
- package/lib/helper.js +21 -18
- package/lib/logger.js +1 -1
- package/lib/querystring.js +1 -1
- package/lib/request-wrapper.js +54 -29
- package/lib/sdk-test-helpers.browser.js +1 -0
- package/lib/sdk-test-helpers.js +8 -7
- package/lib/stream-to-promise.js +1 -0
- package/package.json +40 -6
- package/.cra/.cveignore +0 -2
- package/.secrets.baseline +0 -542
- package/Authentication.md +0 -525
- package/CHANGELOG.md +0 -682
- package/LICENSE.md +0 -201
- package/MIGRATION-V1.md +0 -42
- package/README.md +0 -116
- package/api-extractor.json +0 -39
- package/appscan-config.xml +0 -7
- package/build/docs/ibm-cloud-sdk-core.atleastone.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.atmostone.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.authenticator._constructor_.md +0 -18
- package/build/docs/ibm-cloud-sdk-core.authenticator.authenticate.md +0 -28
- package/build/docs/ibm-cloud-sdk-core.authenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_basic.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_bearertoken.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_container.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_cp4d.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_iam.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_noauth.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_unknown.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.authtype_vpc.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.authenticator.md +0 -41
- package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticate.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.authenticationtype.md +0 -17
- package/build/docs/ibm-cloud-sdk-core.authenticatorinterface.md +0 -21
- package/build/docs/ibm-cloud-sdk-core.baseservice._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.baseservice.baseoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.baseservice.configureservice.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.baseservice.createrequest.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_name.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.baseservice.default_service_url.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.baseservice.disableretries.md +0 -17
- package/build/docs/ibm-cloud-sdk-core.baseservice.enableretries.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.baseservice.getauthenticator.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.baseservice.gethttpclient.md +0 -17
- package/build/docs/ibm-cloud-sdk-core.baseservice.md +0 -44
- package/build/docs/ibm-cloud-sdk-core.baseservice.setdefaultheaders.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.baseservice.setenablegzipcompression.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.baseservice.setserviceurl.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator._constructor_.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticate.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.authheader.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.md +0 -39
- package/build/docs/ibm-cloud-sdk-core.basicauthenticator.requiredoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator._constructor_.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticate.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.md +0 -39
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.requiredoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.bearertokenauthenticator.setbearertoken.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.buildrequestfileobject.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.checkcredentials.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator._constructor_.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.md +0 -38
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.requiredoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.cloudpakfordataauthenticator.tokenmanager.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.computebasicauthheader.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.constructfilepath.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.constructserviceurl.md +0 -28
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator._constructor_.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.md +0 -40
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setcrtokenfilename.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofileid.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.setiamprofilename.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.containerauthenticator.tokenmanager.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.md +0 -30
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.requesttoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setcrtokenfilename.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofileid.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.containertokenmanager.setiamprofilename.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.contenttype.md +0 -14
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.md +0 -35
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md +0 -15
- package/build/docs/ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.fileexistsatpath.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.fileobject.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.fileobject.options.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.fileobject.value.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.fileoptions.contenttype.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.fileoptions.filename.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.fileoptions.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.filestream.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.filestream.path.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.contenttype.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.data.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.filename.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.filewithmetadata.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.getauthenticatorfromenvironment.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.getcontenttype.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.getcurrenttime.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.getformat.md +0 -29
- package/build/docs/ibm-cloud-sdk-core.getmissingparams.md +0 -29
- package/build/docs/ibm-cloud-sdk-core.getnewlogger.md +0 -30
- package/build/docs/ibm-cloud-sdk-core.getqueryparam.md +0 -31
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator._constructor_.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.md +0 -38
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientsecret.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.getrefreshtoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.md +0 -38
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.scope.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setclientidandsecret.md +0 -25
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.setscope.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedauthenticator.tokenmanager.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.formdata.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.getrefreshtoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.md +0 -38
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.refreshtoken.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.requesttoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.savetokeninfo.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setclientidandsecret.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.iamrequestbasedtokenmanager.setscope.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientid.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.clientsecret.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.md +0 -23
- package/build/docs/ibm-cloud-sdk-core.iamrequestoptions.scope.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.iamtokenmanager.requiredoptions.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.isemptyobject.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.isfiledata.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.isfilewithmetadata.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.ishtml.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.md +0 -35
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.requesttoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.savetokeninfo.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokeninfo.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanager.tokenname.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.jwttokenmanageroptions.md +0 -15
- package/build/docs/ibm-cloud-sdk-core.md +0 -96
- package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticate.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.noauthauthenticator.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.onlyone.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.qs.md +0 -21
- package/build/docs/ibm-cloud-sdk-core.readcredentialsfile.md +0 -17
- package/build/docs/ibm-cloud-sdk-core.readcrtokenfile.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.readexternalsources.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.removesuffix.md +0 -27
- package/build/docs/ibm-cloud-sdk-core.sdklogger.debug.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.sdklogger.error.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.sdklogger.info.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.sdklogger.md +0 -22
- package/build/docs/ibm-cloud-sdk-core.sdklogger.verbose.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.sdklogger.warn.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.streamtopromise.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.striptrailingslash.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.tokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.accesstoken.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.disablesslverification.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.expiretime.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.gettoken.md +0 -17
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.headers.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.md +0 -43
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.pacedrequesttoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.refreshtime.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.requesttoken.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.requestwrapperinstance.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.savetokeninfo.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.setdisablesslverification.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.setheaders.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.tokenmanager.url.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenmanageroptions.md +0 -18
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.authenticate.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.disablesslverification.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.headers.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.md +0 -42
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setdisablesslverification.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.setheaders.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.tokenmanager.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tokenrequestbasedauthenticator.url.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.tolowerkeys.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.unittestutils.checkforsuccessfulexecution.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.unittestutils.checkmediaheaders.md +0 -28
- package/build/docs/ibm-cloud-sdk-core.unittestutils.checkurlandmethod.md +0 -28
- package/build/docs/ibm-cloud-sdk-core.unittestutils.checkuserheader.md +0 -28
- package/build/docs/ibm-cloud-sdk-core.unittestutils.expecttobepromise.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.unittestutils.getoptions.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.unittestutils.md +0 -17
- package/build/docs/ibm-cloud-sdk-core.useroptions.authenticator.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.useroptions.disablesslverification.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.useroptions.headers.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.useroptions.jar.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.useroptions.md +0 -26
- package/build/docs/ibm-cloud-sdk-core.useroptions.serviceurl.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.useroptions.url.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.useroptions.version.md +0 -13
- package/build/docs/ibm-cloud-sdk-core.validateinput.md +0 -23
- package/build/docs/ibm-cloud-sdk-core.validateparams.md +0 -30
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.authenticationtype.md +0 -19
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.md +0 -39
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofilecrn.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.setiamprofileid.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.vpcinstanceauthenticator.tokenmanager.md +0 -11
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager._constructor_.md +0 -20
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.md +0 -29
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.requesttoken.md +0 -15
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofilecrn.md +0 -24
- package/build/docs/ibm-cloud-sdk-core.vpcinstancetokenmanager.setiamprofileid.md +0 -24
- package/build/docs/index.md +0 -12
- package/es/tsdoc-metadata.json +0 -11
- package/etc/ibm-cloud-sdk-core.api.md +0 -483
- package/temp/ibm-cloud-sdk-core.api.json +0 -7571
- package/temp/ibm-cloud-sdk-core.api.md +0 -483
- package/tsconfig-es6.json +0 -9
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [contentType](./ibm-cloud-sdk-core.contenttype.md)
|
|
4
|
-
|
|
5
|
-
## contentType variable
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
_default: {
|
|
11
|
-
fromFilename: (file: String | File | FileObject | NodeJS.ReadableStream | Buffer) => string;
|
|
12
|
-
fromHeader: (buffer: Buffer) => string;
|
|
13
|
-
}
|
|
14
|
-
```
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) > [(constructor)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md)
|
|
4
|
-
|
|
5
|
-
## Cp4dTokenManager.(constructor)
|
|
6
|
-
|
|
7
|
-
Create a new \[\[Cp4dTokenManager\]\] instance.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
constructor(options: Options);
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| options | Options | Configuration options. |
|
|
20
|
-
|
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md)
|
|
4
|
-
|
|
5
|
-
## Cp4dTokenManager class
|
|
6
|
-
|
|
7
|
-
Token Manager of CloudPak for data.
|
|
8
|
-
|
|
9
|
-
The Token Manager performs basic auth with a username and password to acquire CP4D tokens.
|
|
10
|
-
|
|
11
|
-
<b>Signature:</b>
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
export declare class Cp4dTokenManager extends JwtTokenManager
|
|
15
|
-
```
|
|
16
|
-
<b>Extends:</b> [JwtTokenManager](./ibm-cloud-sdk-core.jwttokenmanager.md)
|
|
17
|
-
|
|
18
|
-
## Constructors
|
|
19
|
-
|
|
20
|
-
| Constructor | Modifiers | Description |
|
|
21
|
-
| --- | --- | --- |
|
|
22
|
-
| [(constructor)(options)](./ibm-cloud-sdk-core.cp4dtokenmanager._constructor_.md) | | Create a new \[\[Cp4dTokenManager\]\] instance. |
|
|
23
|
-
|
|
24
|
-
## Properties
|
|
25
|
-
|
|
26
|
-
| Property | Modifiers | Type | Description |
|
|
27
|
-
| --- | --- | --- | --- |
|
|
28
|
-
| [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md) | | string\[\] | |
|
|
29
|
-
|
|
30
|
-
## Methods
|
|
31
|
-
|
|
32
|
-
| Method | Modifiers | Description |
|
|
33
|
-
| --- | --- | --- |
|
|
34
|
-
| [requestToken()](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md) | | |
|
|
35
|
-
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) > [requestToken](./ibm-cloud-sdk-core.cp4dtokenmanager.requesttoken.md)
|
|
4
|
-
|
|
5
|
-
## Cp4dTokenManager.requestToken() method
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
protected requestToken(): Promise<any>;
|
|
11
|
-
```
|
|
12
|
-
<b>Returns:</b>
|
|
13
|
-
|
|
14
|
-
Promise<any>
|
|
15
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [Cp4dTokenManager](./ibm-cloud-sdk-core.cp4dtokenmanager.md) > [requiredOptions](./ibm-cloud-sdk-core.cp4dtokenmanager.requiredoptions.md)
|
|
4
|
-
|
|
5
|
-
## Cp4dTokenManager.requiredOptions property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
protected requiredOptions: string[];
|
|
11
|
-
```
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [fileExistsAtPath](./ibm-cloud-sdk-core.fileexistsatpath.md)
|
|
4
|
-
|
|
5
|
-
## fileExistsAtPath() function
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
export declare function fileExistsAtPath(filepath: string): boolean;
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
| Parameter | Type | Description |
|
|
16
|
-
| --- | --- | --- |
|
|
17
|
-
| filepath | string | |
|
|
18
|
-
|
|
19
|
-
<b>Returns:</b>
|
|
20
|
-
|
|
21
|
-
boolean
|
|
22
|
-
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileObject](./ibm-cloud-sdk-core.fileobject.md)
|
|
4
|
-
|
|
5
|
-
## FileObject interface
|
|
6
|
-
|
|
7
|
-
(C) Copyright IBM Corp. 2014, 2021.
|
|
8
|
-
|
|
9
|
-
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
|
|
10
|
-
|
|
11
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
12
|
-
|
|
13
|
-
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.
|
|
14
|
-
|
|
15
|
-
<b>Signature:</b>
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
export interface FileObject
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
| Property | Type | Description |
|
|
24
|
-
| --- | --- | --- |
|
|
25
|
-
| [options?](./ibm-cloud-sdk-core.fileobject.options.md) | [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) | <i>(Optional)</i> |
|
|
26
|
-
| [value](./ibm-cloud-sdk-core.fileobject.value.md) | NodeJS.ReadableStream \| Buffer \| string | |
|
|
27
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileObject](./ibm-cloud-sdk-core.fileobject.md) > [options](./ibm-cloud-sdk-core.fileobject.options.md)
|
|
4
|
-
|
|
5
|
-
## FileObject.options property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
options?: FileOptions;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileObject](./ibm-cloud-sdk-core.fileobject.md) > [value](./ibm-cloud-sdk-core.fileobject.value.md)
|
|
4
|
-
|
|
5
|
-
## FileObject.value property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
value: NodeJS.ReadableStream | Buffer | string;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) > [contentType](./ibm-cloud-sdk-core.fileoptions.contenttype.md)
|
|
4
|
-
|
|
5
|
-
## FileOptions.contentType property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
contentType?: string;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileOptions](./ibm-cloud-sdk-core.fileoptions.md) > [filename](./ibm-cloud-sdk-core.fileoptions.filename.md)
|
|
4
|
-
|
|
5
|
-
## FileOptions.filename property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
filename?: string;
|
|
11
|
-
```
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileOptions](./ibm-cloud-sdk-core.fileoptions.md)
|
|
4
|
-
|
|
5
|
-
## FileOptions interface
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
export interface FileOptions
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
| Property | Type | Description |
|
|
16
|
-
| --- | --- | --- |
|
|
17
|
-
| [contentType?](./ibm-cloud-sdk-core.fileoptions.contenttype.md) | string | <i>(Optional)</i> |
|
|
18
|
-
| [filename?](./ibm-cloud-sdk-core.fileoptions.filename.md) | string | <i>(Optional)</i> |
|
|
19
|
-
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileStream](./ibm-cloud-sdk-core.filestream.md)
|
|
4
|
-
|
|
5
|
-
## FileStream interface
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
export interface FileStream extends NodeJS.ReadableStream
|
|
11
|
-
```
|
|
12
|
-
<b>Extends:</b> NodeJS.ReadableStream
|
|
13
|
-
|
|
14
|
-
## Properties
|
|
15
|
-
|
|
16
|
-
| Property | Type | Description |
|
|
17
|
-
| --- | --- | --- |
|
|
18
|
-
| [path](./ibm-cloud-sdk-core.filestream.path.md) | string \| Buffer | |
|
|
19
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileStream](./ibm-cloud-sdk-core.filestream.md) > [path](./ibm-cloud-sdk-core.filestream.path.md)
|
|
4
|
-
|
|
5
|
-
## FileStream.path property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
path: string | Buffer;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) > [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md)
|
|
4
|
-
|
|
5
|
-
## FileWithMetadata.contentType property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
contentType: string;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) > [data](./ibm-cloud-sdk-core.filewithmetadata.data.md)
|
|
4
|
-
|
|
5
|
-
## FileWithMetadata.data property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
data: NodeJS.ReadableStream | Buffer;
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md) > [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md)
|
|
4
|
-
|
|
5
|
-
## FileWithMetadata.filename property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
filename: string;
|
|
11
|
-
```
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [FileWithMetadata](./ibm-cloud-sdk-core.filewithmetadata.md)
|
|
4
|
-
|
|
5
|
-
## FileWithMetadata interface
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
export interface FileWithMetadata
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Properties
|
|
14
|
-
|
|
15
|
-
| Property | Type | Description |
|
|
16
|
-
| --- | --- | --- |
|
|
17
|
-
| [contentType](./ibm-cloud-sdk-core.filewithmetadata.contenttype.md) | string | |
|
|
18
|
-
| [data](./ibm-cloud-sdk-core.filewithmetadata.data.md) | NodeJS.ReadableStream \| Buffer | |
|
|
19
|
-
| [filename](./ibm-cloud-sdk-core.filewithmetadata.filename.md) | string | |
|
|
20
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getAuthenticatorFromEnvironment](./ibm-cloud-sdk-core.getauthenticatorfromenvironment.md)
|
|
4
|
-
|
|
5
|
-
## getAuthenticatorFromEnvironment() function
|
|
6
|
-
|
|
7
|
-
Look for external configuration of authenticator.
|
|
8
|
-
|
|
9
|
-
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)
|
|
10
|
-
|
|
11
|
-
<b>Signature:</b>
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
export declare function getAuthenticatorFromEnvironment(serviceName: string): Authenticator;
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Parameters
|
|
18
|
-
|
|
19
|
-
| Parameter | Type | Description |
|
|
20
|
-
| --- | --- | --- |
|
|
21
|
-
| serviceName | string | The service name prefix. |
|
|
22
|
-
|
|
23
|
-
<b>Returns:</b>
|
|
24
|
-
|
|
25
|
-
[Authenticator](./ibm-cloud-sdk-core.authenticator.md)
|
|
26
|
-
|
|
@@ -1,26 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getContentType](./ibm-cloud-sdk-core.getcontenttype.md)
|
|
4
|
-
|
|
5
|
-
## getContentType() function
|
|
6
|
-
|
|
7
|
-
This function retrieves the content type of the input.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function getContentType(inputData: NodeJS.ReadableStream | Buffer): Promise<string>;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| inputData | NodeJS.ReadableStream \| Buffer | The data to retrieve content type for. |
|
|
20
|
-
|
|
21
|
-
<b>Returns:</b>
|
|
22
|
-
|
|
23
|
-
Promise<string>
|
|
24
|
-
|
|
25
|
-
{<!-- -->string<!-- -->} the content type of the input.
|
|
26
|
-
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getCurrentTime](./ibm-cloud-sdk-core.getcurrenttime.md)
|
|
4
|
-
|
|
5
|
-
## getCurrentTime() function
|
|
6
|
-
|
|
7
|
-
Get the current time
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function getCurrentTime(): number;
|
|
13
|
-
```
|
|
14
|
-
<b>Returns:</b>
|
|
15
|
-
|
|
16
|
-
number
|
|
17
|
-
|
|
18
|
-
{<!-- -->number<!-- -->} - Returns the current time in seconds.
|
|
19
|
-
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getFormat](./ibm-cloud-sdk-core.getformat.md)
|
|
4
|
-
|
|
5
|
-
## getFormat() function
|
|
6
|
-
|
|
7
|
-
Returns the first match from formats that is key the params map otherwise null
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function getFormat(params: {
|
|
13
|
-
[key: string]: any;
|
|
14
|
-
}, formats: string[]): string;
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Parameters
|
|
18
|
-
|
|
19
|
-
| Parameter | Type | Description |
|
|
20
|
-
| --- | --- | --- |
|
|
21
|
-
| params | { \[key: string\]: any; } | The parameters. |
|
|
22
|
-
| formats | string\[\] | |
|
|
23
|
-
|
|
24
|
-
<b>Returns:</b>
|
|
25
|
-
|
|
26
|
-
string
|
|
27
|
-
|
|
28
|
-
{<!-- -->string\|null<!-- -->}
|
|
29
|
-
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getMissingParams](./ibm-cloud-sdk-core.getmissingparams.md)
|
|
4
|
-
|
|
5
|
-
## getMissingParams() function
|
|
6
|
-
|
|
7
|
-
Validates that all required params are provided
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function getMissingParams(params: {
|
|
13
|
-
[key: string]: any;
|
|
14
|
-
}, requires: string[]): null | Error;
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Parameters
|
|
18
|
-
|
|
19
|
-
| Parameter | Type | Description |
|
|
20
|
-
| --- | --- | --- |
|
|
21
|
-
| params | { \[key: string\]: any; } | the method parameters. |
|
|
22
|
-
| requires | string\[\] | the required parameter names. |
|
|
23
|
-
|
|
24
|
-
<b>Returns:</b>
|
|
25
|
-
|
|
26
|
-
null \| Error
|
|
27
|
-
|
|
28
|
-
{<!-- -->Error\|null<!-- -->}
|
|
29
|
-
|
|
@@ -1,30 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getNewLogger](./ibm-cloud-sdk-core.getnewlogger.md)
|
|
4
|
-
|
|
5
|
-
## getNewLogger() function
|
|
6
|
-
|
|
7
|
-
Return a new logger, formatted with a particular name. The logging functions, in order of increasing verbosity, are: `error`<!-- -->, `warn`<!-- -->, `info`<!-- -->, `verbose`<!-- -->, and `debug`<!-- -->.
|
|
8
|
-
|
|
9
|
-
The logger will be an instance of the `debug` package and utilizes its support for configuration with environment variables.
|
|
10
|
-
|
|
11
|
-
Additionally, the logger will be turned on automatically if the "NODE\_DEBUG" environment variable is set to "axios".
|
|
12
|
-
|
|
13
|
-
<b>Signature:</b>
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
export declare function getNewLogger(moduleName: string): SDKLogger;
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## Parameters
|
|
20
|
-
|
|
21
|
-
| Parameter | Type | Description |
|
|
22
|
-
| --- | --- | --- |
|
|
23
|
-
| 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. |
|
|
24
|
-
|
|
25
|
-
<b>Returns:</b>
|
|
26
|
-
|
|
27
|
-
[SDKLogger](./ibm-cloud-sdk-core.sdklogger.md)
|
|
28
|
-
|
|
29
|
-
{<!-- -->SDKLogger<!-- -->} the new logger
|
|
30
|
-
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [getQueryParam](./ibm-cloud-sdk-core.getqueryparam.md)
|
|
4
|
-
|
|
5
|
-
## getQueryParam() function
|
|
6
|
-
|
|
7
|
-
Return a query parameter value from a URL
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
export declare function getQueryParam(urlStr: string, param: string): string;
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| urlStr | string | the url string. |
|
|
20
|
-
| param | string | the name of the query parameter whose value should be returned |
|
|
21
|
-
|
|
22
|
-
<b>Returns:</b>
|
|
23
|
-
|
|
24
|
-
string
|
|
25
|
-
|
|
26
|
-
{<!-- -->string<!-- -->} the value of the `param` query parameter
|
|
27
|
-
|
|
28
|
-
## Exceptions
|
|
29
|
-
|
|
30
|
-
if urlStr is an invalid URL
|
|
31
|
-
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) > [(constructor)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md)
|
|
4
|
-
|
|
5
|
-
## IamAuthenticator.(constructor)
|
|
6
|
-
|
|
7
|
-
Create a new \[\[IamAuthenticator\]\] instance.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
constructor(options: Options);
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| options | Options | Configuration options for IAM authentication. |
|
|
20
|
-
|
|
21
|
-
## Exceptions
|
|
22
|
-
|
|
23
|
-
{<!-- -->Error<!-- -->} When the configuration options are not valid.
|
|
24
|
-
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) > [authenticationType](./ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md)
|
|
4
|
-
|
|
5
|
-
## IamAuthenticator.authenticationType() method
|
|
6
|
-
|
|
7
|
-
Returns the authenticator's type ('iam').
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
authenticationType(): string;
|
|
13
|
-
```
|
|
14
|
-
<b>Returns:</b>
|
|
15
|
-
|
|
16
|
-
string
|
|
17
|
-
|
|
18
|
-
a string that indicates the authenticator's type
|
|
19
|
-
|
|
@@ -1,38 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md)
|
|
4
|
-
|
|
5
|
-
## IamAuthenticator class
|
|
6
|
-
|
|
7
|
-
The \[\[IamAuthenticator\]\] will use the user-supplied `apikey` values to obtain a bearer token from a token server. When the bearer token expires, a new token is obtained from the token server. If specified, the optional, mutually inclusive `clientId` and`clientSecret` pair can be used to influence rate-limiting for requests to the IAM token server.
|
|
8
|
-
|
|
9
|
-
The bearer token will be sent as an Authorization header in the form:
|
|
10
|
-
|
|
11
|
-
Authorization: Bearer <bearer-token>
|
|
12
|
-
|
|
13
|
-
<b>Signature:</b>
|
|
14
|
-
|
|
15
|
-
```typescript
|
|
16
|
-
export declare class IamAuthenticator extends IamRequestBasedAuthenticator
|
|
17
|
-
```
|
|
18
|
-
<b>Extends:</b> [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md)
|
|
19
|
-
|
|
20
|
-
## Constructors
|
|
21
|
-
|
|
22
|
-
| Constructor | Modifiers | Description |
|
|
23
|
-
| --- | --- | --- |
|
|
24
|
-
| [(constructor)(options)](./ibm-cloud-sdk-core.iamauthenticator._constructor_.md) | | Create a new \[\[IamAuthenticator\]\] instance. |
|
|
25
|
-
|
|
26
|
-
## Properties
|
|
27
|
-
|
|
28
|
-
| Property | Modifiers | Type | Description |
|
|
29
|
-
| --- | --- | --- | --- |
|
|
30
|
-
| [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md) | | string\[\] | |
|
|
31
|
-
| [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md) | | [IamTokenManager](./ibm-cloud-sdk-core.iamtokenmanager.md) | |
|
|
32
|
-
|
|
33
|
-
## Methods
|
|
34
|
-
|
|
35
|
-
| Method | Modifiers | Description |
|
|
36
|
-
| --- | --- | --- |
|
|
37
|
-
| [authenticationType()](./ibm-cloud-sdk-core.iamauthenticator.authenticationtype.md) | | Returns the authenticator's type ('iam'). |
|
|
38
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) > [requiredOptions](./ibm-cloud-sdk-core.iamauthenticator.requiredoptions.md)
|
|
4
|
-
|
|
5
|
-
## IamAuthenticator.requiredOptions property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
protected requiredOptions: string[];
|
|
11
|
-
```
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamAuthenticator](./ibm-cloud-sdk-core.iamauthenticator.md) > [tokenManager](./ibm-cloud-sdk-core.iamauthenticator.tokenmanager.md)
|
|
4
|
-
|
|
5
|
-
## IamAuthenticator.tokenManager property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
protected tokenManager: IamTokenManager;
|
|
11
|
-
```
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) > [(constructor)](./ibm-cloud-sdk-core.iamrequestbasedauthenticator._constructor_.md)
|
|
4
|
-
|
|
5
|
-
## IamRequestBasedAuthenticator.(constructor)
|
|
6
|
-
|
|
7
|
-
Create a new \[\[IamRequestBasedAuthenticator\]\] instance.
|
|
8
|
-
|
|
9
|
-
<b>Signature:</b>
|
|
10
|
-
|
|
11
|
-
```typescript
|
|
12
|
-
constructor(options: IamRequestOptions);
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Parameters
|
|
16
|
-
|
|
17
|
-
| Parameter | Type | Description |
|
|
18
|
-
| --- | --- | --- |
|
|
19
|
-
| options | [IamRequestOptions](./ibm-cloud-sdk-core.iamrequestoptions.md) | Configuration options for IAM authentication. |
|
|
20
|
-
|
|
21
|
-
## Exceptions
|
|
22
|
-
|
|
23
|
-
{<!-- -->Error<!-- -->} When the configuration options are not valid.
|
|
24
|
-
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
-
|
|
3
|
-
[Home](./index.md) > [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) > [IamRequestBasedAuthenticator](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.md) > [clientId](./ibm-cloud-sdk-core.iamrequestbasedauthenticator.clientid.md)
|
|
4
|
-
|
|
5
|
-
## IamRequestBasedAuthenticator.clientId property
|
|
6
|
-
|
|
7
|
-
<b>Signature:</b>
|
|
8
|
-
|
|
9
|
-
```typescript
|
|
10
|
-
protected clientId: string;
|
|
11
|
-
```
|