From d48b5e51d73a47cc9ebaeaef7ad9c4adf4c8f084 Mon Sep 17 00:00:00 2001 From: Junjie Tang Date: Mon, 25 May 2020 23:05:33 +0200 Subject: [PATCH] v1.21.0 --- CHANGELOG.md | 24 +- DOCUMENTATION.md | 2 +- docs/api/1.21.0/assets/css/main.css | 2679 +++++ docs/api/1.21.0/assets/images/icons.png | Bin 0 -> 9615 bytes docs/api/1.21.0/assets/images/icons@2x.png | Bin 0 -> 28144 bytes docs/api/1.21.0/assets/images/widgets.png | Bin 0 -> 480 bytes docs/api/1.21.0/assets/images/widgets@2x.png | Bin 0 -> 855 bytes docs/api/1.21.0/assets/js/main.js | 1 + docs/api/1.21.0/assets/js/search.json | 1 + .../classes/sap_cloud_sdk_core.cache-1.html | 371 + ...cloud_sdk_core.createrequestbuilder-1.html | 694 ++ .../sap_cloud_sdk_core.customfield-1.html | 641 ++ ...cloud_sdk_core.deleterequestbuilder-1.html | 643 ++ .../classes/sap_cloud_sdk_core.entity-1.html | 848 ++ ...k_core.functionimportrequestbuilder-1.html | 636 ++ ...cloud_sdk_core.getallrequestbuilder-1.html | 761 ++ ...oud_sdk_core.getbykeyrequestbuilder-1.html | 622 ++ ..._cloud_sdk_core.odatabatchchangeset-1.html | 247 + .../sap_cloud_sdk_core.odatabatchconfig.html | 596 ++ ...d_sdk_core.odatabatchrequestbuilder-1.html | 598 ++ ...oud_sdk_core.odatacreaterequestconfig.html | 654 ++ ...oud_sdk_core.odatadeleterequestconfig.html | 644 ++ ...core.odatafunctionimportrequestconfig.html | 636 ++ ...oud_sdk_core.odatagetallrequestconfig.html | 688 ++ ...d_sdk_core.odatagetbykeyrequestconfig.html | 644 ++ ...oud_sdk_core.odataupdaterequestconfig.html | 666 ++ ...cloud_sdk_core.updaterequestbuilder-1.html | 779 ++ ...oud_sdk_generator.globalnameformatter.html | 261 + ...ud_sdk_generator.servicenameformatter.html | 492 + ...ap_cloud_sdk_core.destinationorigin-1.html | 195 + .../sap_cloud_sdk_core.httpmethod-1.html | 263 + ...ap_cloud_sdk_core.isolationstrategy-1.html | 219 + .../enums/sap_cloud_sdk_core.protocol-1.html | 235 + .../sap_cloud_sdk_core.proxystrategy-2.html | 206 + ...r.vdmfunctionimportreturntypecategory.html | 212 + docs/api/1.21.0/globals.html | 143 + docs/api/1.21.0/index.html | 146 + ...d_sdk_analytics.usageanalyticsoptions.html | 210 + .../sap_cloud_sdk_core.cachingoptions-1.html | 204 + ...ap_cloud_sdk_core.clientcredentials-1.html | 193 + ...p_cloud_sdk_core.completedecodedjwt-1.html | 459 + .../sap_cloud_sdk_core.decodedjwt-1.html | 431 + .../sap_cloud_sdk_core.destination-1.html | 636 ++ ...sdk_core.destinationaccessoroptions-1.html | 203 + ...cloud_sdk_core.destinationauthtoken-1.html | 228 + ..._sdk_core.destinationcachingoptions-1.html | 213 + ...oud_sdk_core.destinationcertificate-1.html | 229 + ...d_sdk_core.destinationconfiguration-1.html | 391 + ...estinationforservicebindingsoptions-1.html | 191 + ...k_core.destinationhttprequestconfig-1.html | 221 + .../sap_cloud_sdk_core.destinationjson-1.html | 223 + ...loud_sdk_core.destinationnameandjwt-1.html | 216 + ..._core.destinationservicecredentials-1.html | 326 + .../sap_cloud_sdk_core.httpagentconfig-1.html | 186 + .../sap_cloud_sdk_core.httpreponse-1.html | 234 + ...ap_cloud_sdk_core.httprequestconfig-1.html | 312 + .../sap_cloud_sdk_core.httpresponse-1.html | 218 + ...sap_cloud_sdk_core.httpsagentconfig-1.html | 186 + .../sap_cloud_sdk_core.jwtheader-1.html | 214 + .../sap_cloud_sdk_core.jwtpayload-1.html | 425 + ...p_cloud_sdk_core.proxyconfiguration-1.html | 260 + ...d_sdk_core.registeredjwtclaimsbasic-1.html | 270 + ...ud_sdk_core.registeredjwtclaimstenant.html | 200 + ...loud_sdk_core.registeredjwtclaimsuser.html | 270 + ...ap_cloud_sdk_core.resilienceoptions-1.html | 184 + .../interfaces/sap_cloud_sdk_core.scope.html | 186 + .../sap_cloud_sdk_core.service-1.html | 225 + .../sap_cloud_sdk_core.servicebinding-1.html | 237 + ...p_cloud_sdk_core.servicecredentials-1.html | 209 + .../interfaces/sap_cloud_sdk_core.tenant.html | 200 + .../sap_cloud_sdk_core.tokenkey-1.html | 306 + .../interfaces/sap_cloud_sdk_core.user.html | 310 + .../sap_cloud_sdk_core.userdata.html | 275 + ...sap_cloud_sdk_core.verifyjwtoptions-1.html | 186 + ...ud_sdk_core.xsuaaservicecredentials-1.html | 326 + ..._sdk_generator.apibusinesshubmetadata.html | 207 + .../sap_cloud_sdk_generator.doctype.html | 198 + ...p_cloud_sdk_generator.edmxassociation.html | 207 + ...loud_sdk_generator.edmxassociationset.html | 263 + ...p_cloud_sdk_generator.edmxcomplextype.html | 193 + ...ap_cloud_sdk_generator.edmxdocumented.html | 187 + ...sap_cloud_sdk_generator.edmxentityset.html | 263 + ...ap_cloud_sdk_generator.edmxentitytype.html | 249 + ...loud_sdk_generator.edmxfunctionimport.html | 249 + .../sap_cloud_sdk_generator.edmxmetadata.html | 305 + ...sap_cloud_sdk_generator.edmxparameter.html | 227 + .../sap_cloud_sdk_generator.edmxproperty.html | 339 + ...p_cloud_sdk_generator.edmxpropertyref.html | 179 + .../sap_cloud_sdk_generator.nameddoctype.html | 214 + ...d_sdk_generator.parsedservicemetadata.html | 193 + ..._sdk_generator.servicedefinitionpaths.html | 193 + ...ap_cloud_sdk_generator.servicemapping.html | 207 + ..._cloud_sdk_generator.swaggerdescribed.html | 190 + ...sap_cloud_sdk_generator.swaggerentity.html | 235 + ...p_cloud_sdk_generator.swaggermetadata.html | 300 + .../sap_cloud_sdk_generator.swaggerpath.html | 193 + ...ud_sdk_generator.swaggerpathparameter.html | 227 + ...p_cloud_sdk_generator.swaggerproperty.html | 297 + ...ap_cloud_sdk_generator.vdmcomplextype.html | 235 + .../sap_cloud_sdk_generator.vdmentity.html | 305 + ...cloud_sdk_generator.vdmfunctionimport.html | 263 + ...generator.vdmfunctionimportreturntype.html | 221 + ..._cloud_sdk_generator.vdmmappededmtype.html | 201 + .../sap_cloud_sdk_generator.vdmmapping.html | 151 + ...d_sdk_generator.vdmnavigationproperty.html | 315 + .../sap_cloud_sdk_generator.vdmparameter.html | 256 + .../sap_cloud_sdk_generator.vdmproperty.html | 339 + ...d_sdk_generator.vdmpropertydescriptor.html | 243 + ...generator.vdmpropertyvalueconstraints.html | 198 + ...loud_sdk_generator.vdmservicemetadata.html | 333 + ...k_test_util.gettestdestinationoptions.html | 214 + .../sap_cloud_sdk_util.loggeroptions.html | 275 + .../sap_cloud_sdk_util.maptype.html | 234 + .../sap_cloud_sdk_util.messagecontextobj.html | 270 + .../modules/sap_cloud_sdk_analytics.html | 193 + .../1.21.0/modules/sap_cloud_sdk_core.html | 8890 +++++++++++++++++ .../modules/sap_cloud_sdk_generator.html | 3199 ++++++ .../modules/sap_cloud_sdk_test_util.html | 473 + .../1.21.0/modules/sap_cloud_sdk_util.html | 943 ++ docs/api/versions.js | 1 + docs/api/versions.json | 1 + lerna.json | 2 +- packages/analytics/package-lock.json | 2 +- packages/analytics/package.json | 4 +- packages/core/package-lock.json | 2 +- packages/core/package.json | 6 +- packages/generator/package-lock.json | 2 +- packages/generator/package.json | 8 +- packages/test-util/package-lock.json | 2 +- packages/test-util/package.json | 6 +- packages/util/package-lock.json | 2 +- packages/util/package.json | 2 +- .../integration-tests/package-lock.json | 2 +- test-packages/integration-tests/package.json | 12 +- test-packages/test-services/package-lock.json | 2 +- test-packages/test-services/package.json | 4 +- test-packages/type-tests/package-lock.json | 2 +- test-packages/type-tests/package.json | 6 +- typedoc.json | 2 +- 139 files changed, 49540 insertions(+), 36 deletions(-) create mode 100644 docs/api/1.21.0/assets/css/main.css create mode 100644 docs/api/1.21.0/assets/images/icons.png create mode 100644 docs/api/1.21.0/assets/images/icons@2x.png create mode 100644 docs/api/1.21.0/assets/images/widgets.png create mode 100644 docs/api/1.21.0/assets/images/widgets@2x.png create mode 100644 docs/api/1.21.0/assets/js/main.js create mode 100644 docs/api/1.21.0/assets/js/search.json create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.cache-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.createrequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.customfield-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.deleterequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.entity-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.functionimportrequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.getallrequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.getbykeyrequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchchangeset-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchrequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_core.updaterequestbuilder-1.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_generator.globalnameformatter.html create mode 100644 docs/api/1.21.0/classes/sap_cloud_sdk_generator.servicenameformatter.html create mode 100644 docs/api/1.21.0/enums/sap_cloud_sdk_core.destinationorigin-1.html create mode 100644 docs/api/1.21.0/enums/sap_cloud_sdk_core.httpmethod-1.html create mode 100644 docs/api/1.21.0/enums/sap_cloud_sdk_core.isolationstrategy-1.html create mode 100644 docs/api/1.21.0/enums/sap_cloud_sdk_core.protocol-1.html create mode 100644 docs/api/1.21.0/enums/sap_cloud_sdk_core.proxystrategy-2.html create mode 100644 docs/api/1.21.0/enums/sap_cloud_sdk_generator.vdmfunctionimportreturntypecategory.html create mode 100644 docs/api/1.21.0/globals.html create mode 100644 docs/api/1.21.0/index.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_analytics.usageanalyticsoptions.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.cachingoptions-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.clientcredentials-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.completedecodedjwt-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.decodedjwt-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destination-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationaccessoroptions-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationauthtoken-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcachingoptions-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcertificate-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationconfiguration-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationjson-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationnameandjwt-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationservicecredentials-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpagentconfig-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpreponse-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httprequestconfig-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpresponse-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpsagentconfig-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtheader-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtpayload-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.proxyconfiguration-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.resilienceoptions-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.scope.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.service-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicebinding-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicecredentials-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tenant.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tokenkey-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.user.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.userdata.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.verifyjwtoptions-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials-1.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.apibusinesshubmetadata.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.doctype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociation.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociationset.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxcomplextype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxdocumented.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentityset.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentitytype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxfunctionimport.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxmetadata.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxparameter.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxproperty.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxpropertyref.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.nameddoctype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.parsedservicemetadata.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicedefinitionpaths.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicemapping.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerdescribed.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerentity.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggermetadata.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpath.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpathparameter.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerproperty.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmcomplextype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmentity.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimport.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimportreturntype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmappededmtype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmapping.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmnavigationproperty.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmparameter.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmproperty.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertydescriptor.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertyvalueconstraints.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmservicemetadata.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_util.loggeroptions.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_util.maptype.html create mode 100644 docs/api/1.21.0/interfaces/sap_cloud_sdk_util.messagecontextobj.html create mode 100644 docs/api/1.21.0/modules/sap_cloud_sdk_analytics.html create mode 100644 docs/api/1.21.0/modules/sap_cloud_sdk_core.html create mode 100644 docs/api/1.21.0/modules/sap_cloud_sdk_generator.html create mode 100644 docs/api/1.21.0/modules/sap_cloud_sdk_test_util.html create mode 100644 docs/api/1.21.0/modules/sap_cloud_sdk_util.html diff --git a/CHANGELOG.md b/CHANGELOG.md index f1e7b3d380..90779be07d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -14,6 +14,29 @@ ## Compatibility Notes +- + +## New Functionality + +- + +## Improvements + +- + +## Fixed Issues + +- + + +# 1.21.0 + +Release Date: TBD +API Docs: https://sap.github.io/cloud-sdk/api/1.21.0 +Blog: TBD + +## Compatibility Notes + - New generated OData clients yield more narrow types on the `_keys`, `_keyFields` and `_allFields` properties, that differ from older generated clients. Old clients are still supported but will be deprecated soon. - Internal directory structure has changed. This is a breaking change for users that reference internal modules directly. @@ -30,7 +53,6 @@ - Fix the OData client generator to avoid a compilation error when a complex type only contain complex types. - Fix the dependency versions in the aggregator package generated by the OData client generator. - # 1.20.1 Release Date: TBD diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 8573220d83..901e08c13b 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,4 +1,4 @@ -## Version: 1.20.1 +## Version: 1.21.0 The SAP Cloud SDK for JavaScript and TypeScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Cloud Platform. diff --git a/docs/api/1.21.0/assets/css/main.css b/docs/api/1.21.0/assets/css/main.css new file mode 100644 index 0000000000..959edd7320 --- /dev/null +++ b/docs/api/1.21.0/assets/css/main.css @@ -0,0 +1,2679 @@ +/*! normalize.css v1.1.3 | MIT License | git.io/normalize */ +/* ========================================================================== + * * HTML5 display definitions + * * ========================================================================== */ +/** + * * Correct `block` display not defined in IE 6/7/8/9 and Firefox 3. */ +article, aside, details, figcaption, figure, footer, header, hgroup, main, nav, section, summary { + display: block; +} + +/** + * * Correct `inline-block` display not defined in IE 6/7/8/9 and Firefox 3. */ +audio, canvas, video { + display: inline-block; + *display: inline; + *zoom: 1; +} + +/** + * * Prevent modern browsers from displaying `audio` without controls. + * * Remove excess height in iOS 5 devices. */ +audio:not([controls]) { + display: none; + height: 0; +} + +/** + * * Address styling not present in IE 7/8/9, Firefox 3, and Safari 4. + * * Known issue: no IE 6 support. */ +[hidden] { + display: none; +} + +/* ========================================================================== + * * Base + * * ========================================================================== */ +/** + * * 1. Correct text resizing oddly in IE 6/7 when body `font-size` is set using + * * `em` units. + * * 2. Prevent iOS text size adjust after orientation change, without disabling + * * user zoom. */ +html { + font-size: 100%; + /* 1 */ + -ms-text-size-adjust: 100%; + /* 2 */ + -webkit-text-size-adjust: 100%; + /* 2 */ + font-family: sans-serif; +} + +/** + * * Address `font-family` inconsistency between `textarea` and other form + * * elements. */ +button, input, select, textarea { + font-family: sans-serif; +} + +/** + * * Address margins handled incorrectly in IE 6/7. */ +body { + margin: 0; +} + +/* ========================================================================== + * * Links + * * ========================================================================== */ +/** + * * Address `outline` inconsistency between Chrome and other browsers. */ +a:focus { + outline: thin dotted; +} +a:active, a:hover { + outline: 0; +} + +/** + * * Improve readability when focused and also mouse hovered in all browsers. */ +/* ========================================================================== + * * Typography + * * ========================================================================== */ +/** + * * Address font sizes and margins set differently in IE 6/7. + * * Address font sizes within `section` and `article` in Firefox 4+, Safari 5, + * * and Chrome. */ +h1 { + font-size: 2em; + margin: 0.67em 0; +} + +h2 { + font-size: 1.5em; + margin: 0.83em 0; +} + +h3 { + font-size: 1.17em; + margin: 1em 0; +} + +h4, .tsd-index-panel h3 { + font-size: 1em; + margin: 1.33em 0; +} + +h5 { + font-size: 0.83em; + margin: 1.67em 0; +} + +h6 { + font-size: 0.67em; + margin: 2.33em 0; +} + +/** + * * Address styling not present in IE 7/8/9, Safari 5, and Chrome. */ +abbr[title] { + border-bottom: 1px dotted; +} + +/** + * * Address style set to `bolder` in Firefox 3+, Safari 4/5, and Chrome. */ +b, strong { + font-weight: bold; +} + +blockquote { + margin: 1em 40px; +} + +/** + * * Address styling not present in Safari 5 and Chrome. */ +dfn { + font-style: italic; +} + +/** + * * Address differences between Firefox and other browsers. + * * Known issue: no IE 6/7 normalization. */ +hr { + box-sizing: content-box; + height: 0; +} + +/** + * * Address styling not present in IE 6/7/8/9. */ +mark { + background: #ff0; + color: #000; +} + +/** + * * Address margins set differently in IE 6/7. */ +p, pre { + margin: 1em 0; +} + +/** + * * Correct font family set oddly in IE 6, Safari 4/5, and Chrome. */ +code, kbd, pre, samp { + font-family: monospace, serif; + _font-family: "courier new", monospace; + font-size: 1em; +} + +/** + * * Improve readability of pre-formatted text in all browsers. */ +pre { + white-space: pre; + white-space: pre-wrap; + word-wrap: break-word; +} + +/** + * * Address CSS quotes not supported in IE 6/7. */ +q { + quotes: none; +} +q:before, q:after { + content: ""; + content: none; +} + +/** + * * Address `quotes` property not supported in Safari 4. */ +/** + * * Address inconsistent and variable font size in all browsers. */ +small { + font-size: 80%; +} + +/** + * * Prevent `sub` and `sup` affecting `line-height` in all browsers. */ +sub { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; +} + +sup { + font-size: 75%; + line-height: 0; + position: relative; + vertical-align: baseline; + top: -0.5em; +} + +sub { + bottom: -0.25em; +} + +/* ========================================================================== + * * Lists + * * ========================================================================== */ +/** + * * Address margins set differently in IE 6/7. */ +dl, menu, ol, ul { + margin: 1em 0; +} + +dd { + margin: 0 0 0 40px; +} + +/** + * * Address paddings set differently in IE 6/7. */ +menu, ol, ul { + padding: 0 0 0 40px; +} + +/** + * * Correct list images handled incorrectly in IE 7. */ +nav ul, nav ol { + list-style: none; + list-style-image: none; +} + +/* ========================================================================== + * * Embedded content + * * ========================================================================== */ +/** + * * 1. Remove border when inside `a` element in IE 6/7/8/9 and Firefox 3. + * * 2. Improve image quality when scaled in IE 7. */ +img { + border: 0; + /* 1 */ + -ms-interpolation-mode: bicubic; +} + +/* 2 */ +/** + * * Correct overflow displayed oddly in IE 9. */ +svg:not(:root) { + overflow: hidden; +} + +/* ========================================================================== + * * Figures + * * ========================================================================== */ +/** + * * Address margin not present in IE 6/7/8/9, Safari 5, and Opera 11. */ +figure, form { + margin: 0; +} + +/* ========================================================================== + * * Forms + * * ========================================================================== */ +/** + * * Correct margin displayed oddly in IE 6/7. */ +/** + * * Define consistent border, margin, and padding. */ +fieldset { + border: 1px solid #c0c0c0; + margin: 0 2px; + padding: 0.35em 0.625em 0.75em; +} + +/** + * * 1. Correct color not being inherited in IE 6/7/8/9. + * * 2. Correct text not wrapping in Firefox 3. + * * 3. Correct alignment displayed oddly in IE 6/7. */ +legend { + border: 0; + /* 1 */ + padding: 0; + white-space: normal; + /* 2 */ + *margin-left: -7px; +} + +/* 3 */ +/** + * * 1. Correct font size not being inherited in all browsers. + * * 2. Address margins set differently in IE 6/7, Firefox 3+, Safari 5, + * * and Chrome. + * * 3. Improve appearance and consistency in all browsers. */ +button, input, select, textarea { + font-size: 100%; + /* 1 */ + margin: 0; + /* 2 */ + vertical-align: baseline; + /* 3 */ + *vertical-align: middle; +} + +/* 3 */ +/** + * * Address Firefox 3+ setting `line-height` on `input` using `!important` in + * * the UA stylesheet. */ +button, input { + line-height: normal; +} + +/** + * * Address inconsistent `text-transform` inheritance for `button` and `select`. + * * All other form control elements do not inherit `text-transform` values. + * * Correct `button` style inheritance in Chrome, Safari 5+, and IE 6+. + * * Correct `select` style inheritance in Firefox 4+ and Opera. */ +button, select { + text-transform: none; +} + +/** + * * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio` + * * and `video` controls. + * * 2. Correct inability to style clickable `input` types in iOS. + * * 3. Improve usability and consistency of cursor style between image-type + * * `input` and others. + * * 4. Remove inner spacing in IE 7 without affecting normal text inputs. + * * Known issue: inner spacing remains in IE 6. */ +button, html input[type=button] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +input[type=reset], input[type=submit] { + -webkit-appearance: button; + /* 2 */ + cursor: pointer; + /* 3 */ + *overflow: visible; +} + +/* 4 */ +/** + * * Re-set default cursor for disabled elements. */ +button[disabled], html input[disabled] { + cursor: default; +} + +/** + * * 1. Address box sizing set to content-box in IE 8/9. + * * 2. Remove excess padding in IE 8/9. + * * 3. Remove excess padding in IE 7. + * * Known issue: excess padding remains in IE 6. */ +input { + /* 3 */ +} +input[type=checkbox], input[type=radio] { + box-sizing: border-box; + /* 1 */ + padding: 0; + /* 2 */ + *height: 13px; + /* 3 */ + *width: 13px; +} +input[type=search] { + -webkit-appearance: textfield; + /* 1 */ + /* 2 */ + box-sizing: content-box; +} +input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { + -webkit-appearance: none; +} + +/** + * * 1. Address `appearance` set to `searchfield` in Safari 5 and Chrome. + * * 2. Address `box-sizing` set to `border-box` in Safari 5 and Chrome + * * (include `-moz` to future-proof). */ +/** + * * Remove inner padding and search cancel button in Safari 5 and Chrome + * * on OS X. */ +/** + * * Remove inner padding and border in Firefox 3+. */ +button::-moz-focus-inner, input::-moz-focus-inner { + border: 0; + padding: 0; +} + +/** + * * 1. Remove default vertical scrollbar in IE 6/7/8/9. + * * 2. Improve readability and alignment in all browsers. */ +textarea { + overflow: auto; + /* 1 */ + vertical-align: top; +} + +/* 2 */ +/* ========================================================================== + * * Tables + * * ========================================================================== */ +/** + * * Remove most spacing between table cells. */ +table { + border-collapse: collapse; + border-spacing: 0; +} + +/* * + * *Visual Studio-like style based on original C# coloring by Jason Diamond */ +.hljs { + display: inline-block; + padding: 0.5em; + background: white; + color: black; +} + +.hljs-comment, .hljs-annotation, .hljs-template_comment, .diff .hljs-header, .hljs-chunk, .apache .hljs-cbracket { + color: #008000; +} + +.hljs-keyword, .hljs-id, .hljs-built_in, .css .smalltalk .hljs-class, .hljs-winutils, .bash .hljs-variable, .tex .hljs-command, .hljs-request, .hljs-status, .nginx .hljs-title { + color: #00f; +} + +.xml .hljs-tag { + color: #00f; +} +.xml .hljs-tag .hljs-value { + color: #00f; +} + +.hljs-string, .hljs-title, .hljs-parent, .hljs-tag .hljs-value, .hljs-rules .hljs-value { + color: #a31515; +} + +.ruby .hljs-symbol { + color: #a31515; +} +.ruby .hljs-symbol .hljs-string { + color: #a31515; +} + +.hljs-template_tag, .django .hljs-variable, .hljs-addition, .hljs-flow, .hljs-stream, .apache .hljs-tag, .hljs-date, .tex .hljs-formula, .coffeescript .hljs-attribute { + color: #a31515; +} + +.ruby .hljs-string, .hljs-decorator, .hljs-filter .hljs-argument, .hljs-localvars, .hljs-array, .hljs-attr_selector, .hljs-pseudo, .hljs-pi, .hljs-doctype, .hljs-deletion, .hljs-envvar, .hljs-shebang, .hljs-preprocessor, .hljs-pragma, .userType, .apache .hljs-sqbracket, .nginx .hljs-built_in, .tex .hljs-special, .hljs-prompt { + color: #2b91af; +} + +.hljs-phpdoc, .hljs-javadoc, .hljs-xmlDocTag { + color: #808080; +} + +.vhdl .hljs-typename { + font-weight: bold; +} +.vhdl .hljs-string { + color: #666666; +} +.vhdl .hljs-literal { + color: #a31515; +} +.vhdl .hljs-attribute { + color: #00b0e8; +} + +.xml .hljs-attribute { + color: #f00; +} + +ul.tsd-descriptions > li > :first-child, .tsd-panel > :first-child, .col > :first-child, .col-11 > :first-child, .col-10 > :first-child, .col-9 > :first-child, .col-8 > :first-child, .col-7 > :first-child, .col-6 > :first-child, .col-5 > :first-child, .col-4 > :first-child, .col-3 > :first-child, .col-2 > :first-child, .col-1 > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child, +.tsd-panel > :first-child > :first-child, +.col > :first-child > :first-child, +.col-11 > :first-child > :first-child, +.col-10 > :first-child > :first-child, +.col-9 > :first-child > :first-child, +.col-8 > :first-child > :first-child, +.col-7 > :first-child > :first-child, +.col-6 > :first-child > :first-child, +.col-5 > :first-child > :first-child, +.col-4 > :first-child > :first-child, +.col-3 > :first-child > :first-child, +.col-2 > :first-child > :first-child, +.col-1 > :first-child > :first-child, +ul.tsd-descriptions > li > :first-child > :first-child > :first-child, +.tsd-panel > :first-child > :first-child > :first-child, +.col > :first-child > :first-child > :first-child, +.col-11 > :first-child > :first-child > :first-child, +.col-10 > :first-child > :first-child > :first-child, +.col-9 > :first-child > :first-child > :first-child, +.col-8 > :first-child > :first-child > :first-child, +.col-7 > :first-child > :first-child > :first-child, +.col-6 > :first-child > :first-child > :first-child, +.col-5 > :first-child > :first-child > :first-child, +.col-4 > :first-child > :first-child > :first-child, +.col-3 > :first-child > :first-child > :first-child, +.col-2 > :first-child > :first-child > :first-child, +.col-1 > :first-child > :first-child > :first-child { + margin-top: 0; +} +ul.tsd-descriptions > li > :last-child, .tsd-panel > :last-child, .col > :last-child, .col-11 > :last-child, .col-10 > :last-child, .col-9 > :last-child, .col-8 > :last-child, .col-7 > :last-child, .col-6 > :last-child, .col-5 > :last-child, .col-4 > :last-child, .col-3 > :last-child, .col-2 > :last-child, .col-1 > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child, +.tsd-panel > :last-child > :last-child, +.col > :last-child > :last-child, +.col-11 > :last-child > :last-child, +.col-10 > :last-child > :last-child, +.col-9 > :last-child > :last-child, +.col-8 > :last-child > :last-child, +.col-7 > :last-child > :last-child, +.col-6 > :last-child > :last-child, +.col-5 > :last-child > :last-child, +.col-4 > :last-child > :last-child, +.col-3 > :last-child > :last-child, +.col-2 > :last-child > :last-child, +.col-1 > :last-child > :last-child, +ul.tsd-descriptions > li > :last-child > :last-child > :last-child, +.tsd-panel > :last-child > :last-child > :last-child, +.col > :last-child > :last-child > :last-child, +.col-11 > :last-child > :last-child > :last-child, +.col-10 > :last-child > :last-child > :last-child, +.col-9 > :last-child > :last-child > :last-child, +.col-8 > :last-child > :last-child > :last-child, +.col-7 > :last-child > :last-child > :last-child, +.col-6 > :last-child > :last-child > :last-child, +.col-5 > :last-child > :last-child > :last-child, +.col-4 > :last-child > :last-child > :last-child, +.col-3 > :last-child > :last-child > :last-child, +.col-2 > :last-child > :last-child > :last-child, +.col-1 > :last-child > :last-child > :last-child { + margin-bottom: 0; +} + +.container { + max-width: 1200px; + margin: 0 auto; + padding: 0 40px; +} +@media (max-width: 640px) { + .container { + padding: 0 20px; + } +} + +.container-main { + padding-bottom: 200px; +} + +.row { + display: -ms-flexbox; + display: flex; + position: relative; + margin: 0 -10px; +} +.row:after { + visibility: hidden; + display: block; + content: ""; + clear: both; + height: 0; +} + +.col, .col-11, .col-10, .col-9, .col-8, .col-7, .col-6, .col-5, .col-4, .col-3, .col-2, .col-1 { + box-sizing: border-box; + float: left; + padding: 0 10px; +} + +.col-1 { + width: 8.3333333333%; +} + +.offset-1 { + margin-left: 8.3333333333%; +} + +.col-2 { + width: 16.6666666667%; +} + +.offset-2 { + margin-left: 16.6666666667%; +} + +.col-3 { + width: 25%; +} + +.offset-3 { + margin-left: 25%; +} + +.col-4 { + width: 33.3333333333%; +} + +.offset-4 { + margin-left: 33.3333333333%; +} + +.col-5 { + width: 41.6666666667%; +} + +.offset-5 { + margin-left: 41.6666666667%; +} + +.col-6 { + width: 50%; +} + +.offset-6 { + margin-left: 50%; +} + +.col-7 { + width: 58.3333333333%; +} + +.offset-7 { + margin-left: 58.3333333333%; +} + +.col-8 { + width: 66.6666666667%; +} + +.offset-8 { + margin-left: 66.6666666667%; +} + +.col-9 { + width: 75%; +} + +.offset-9 { + margin-left: 75%; +} + +.col-10 { + width: 83.3333333333%; +} + +.offset-10 { + margin-left: 83.3333333333%; +} + +.col-11 { + width: 91.6666666667%; +} + +.offset-11 { + margin-left: 91.6666666667%; +} + +.tsd-kind-icon { + display: block; + position: relative; + padding-left: 20px; + text-indent: -20px; +} +.tsd-kind-icon:before { + content: ""; + display: inline-block; + vertical-align: middle; + width: 17px; + height: 17px; + margin: 0 3px 2px 0; + background-image: url(../images/icons.png); +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-kind-icon:before { + background-image: url(../images/icons@2x.png); + background-size: 238px 204px; + } +} + +.tsd-signature.tsd-kind-icon:before { + background-position: 0 -153px; +} + +.tsd-kind-object-literal > .tsd-kind-icon:before { + background-position: 0px -17px; +} +.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -17px; +} +.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -17px; +} + +.tsd-kind-class > .tsd-kind-icon:before { + background-position: 0px -34px; +} +.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -34px; +} +.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -34px; +} + +.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -51px; +} +.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -51px; +} + +.tsd-kind-interface > .tsd-kind-icon:before { + background-position: 0px -68px; +} +.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -68px; +} +.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -68px; +} + +.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -85px; +} +.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -85px; +} + +.tsd-kind-namespace > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-module > .tsd-kind-icon:before { + background-position: 0px -102px; +} +.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -102px; +} +.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -102px; +} + +.tsd-kind-enum > .tsd-kind-icon:before { + background-position: 0px -119px; +} +.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -119px; +} +.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -119px; +} + +.tsd-kind-enum-member > .tsd-kind-icon:before { + background-position: 0px -136px; +} +.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -136px; +} +.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -136px; +} + +.tsd-kind-signature > .tsd-kind-icon:before { + background-position: 0px -153px; +} +.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -153px; +} +.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -153px; +} + +.tsd-kind-type-alias > .tsd-kind-icon:before { + background-position: 0px -170px; +} +.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -170px; +} +.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -170px; +} + +.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: 0px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -17px -187px; +} +.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -34px -187px; +} + +.tsd-kind-variable > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-property > .tsd-kind-icon:before { + background-position: -136px -0px; +} +.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -0px; +} +.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -0px; +} +.tsd-kind-property.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -0px; +} +.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -0px; +} +.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -0px; +} + +.tsd-kind-get-signature > .tsd-kind-icon:before { + background-position: -136px -17px; +} +.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -17px; +} +.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -17px; +} +.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -17px; +} + +.tsd-kind-set-signature > .tsd-kind-icon:before { + background-position: -136px -34px; +} +.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -34px; +} +.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -34px; +} +.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -34px; +} + +.tsd-kind-accessor > .tsd-kind-icon:before { + background-position: -136px -51px; +} +.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -51px; +} +.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -51px; +} +.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -51px; +} + +.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -68px; +} +.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -68px; +} +.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -68px; +} +.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -68px; +} + +.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { + background-position: -136px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -85px; +} +.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -85px; +} + +.tsd-kind-constructor > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-constructor-signature > .tsd-kind-icon:before { + background-position: -136px -102px; +} +.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -102px; +} +.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -102px; +} +.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -102px; +} + +.tsd-kind-index-signature > .tsd-kind-icon:before { + background-position: -136px -119px; +} +.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -119px; +} +.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -119px; +} +.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -119px; +} + +.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -136px; +} +.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -136px; +} +.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -136px; +} +.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -136px; +} +.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -136px; +} +.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -136px; +} + +.tsd-is-static > .tsd-kind-icon:before { + background-position: -136px -153px; +} +.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -153px; +} +.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -153px; +} +.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -153px; +} +.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -153px; +} +.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -153px; +} +.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -153px; +} + +.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { + background-position: -136px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -170px; +} +.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -170px; +} + +.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { + background-position: -136px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { + background-position: -153px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { + background-position: -51px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -68px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { + background-position: -85px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -102px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { + background-position: -170px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { + background-position: -187px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { + background-position: -119px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { + background-position: -204px -187px; +} +.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited > .tsd-kind-icon:before { + background-position: -221px -187px; +} + +@keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } +} +@keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } +} +@keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } +} +@keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } +} +@keyframes shift-to-left { + from { + transform: translate(0, 0); + } + to { + transform: translate(-25%, 0); + } +} +@keyframes unshift-to-left { + from { + transform: translate(-25%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } +} +@keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } +} +body { + background: #fdfdfd; + font-family: "Segoe UI", sans-serif; + font-size: 16px; + color: #222; +} + +a { + color: #4da6ff; + text-decoration: none; +} +a:hover { + text-decoration: underline; +} + +code, pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 14px; + background-color: rgba(0, 0, 0, 0.04); +} + +pre { + padding: 10px; +} +pre code { + padding: 0; + font-size: 100%; + background-color: transparent; +} + +.tsd-typography { + line-height: 1.333em; +} +.tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-typography h4, .tsd-typography .tsd-index-panel h3, .tsd-index-panel .tsd-typography h3, .tsd-typography h5, .tsd-typography h6 { + font-size: 1em; + margin: 0; +} +.tsd-typography h5, .tsd-typography h6 { + font-weight: normal; +} +.tsd-typography p, .tsd-typography ul, .tsd-typography ol { + margin: 1em 0; +} + +@media (min-width: 901px) and (max-width: 1024px) { + html.default .col-content { + width: 72%; + } + html.default .col-menu { + width: 28%; + } + html.default .tsd-navigation { + padding-left: 10px; + } +} +@media (max-width: 900px) { + html.default .col-content { + float: none; + width: 100%; + } + html.default .col-menu { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + width: 100%; + padding: 20px 20px 0 0; + max-width: 450px; + visibility: hidden; + background-color: #fff; + transform: translate(100%, 0); + } + html.default .col-menu > *:last-child { + padding-bottom: 20px; + } + html.default .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + html.default.to-has-menu .overlay { + animation: fade-in 0.4s; + } + html.default.to-has-menu header, +html.default.to-has-menu footer, +html.default.to-has-menu .col-content { + animation: shift-to-left 0.4s; + } + html.default.to-has-menu .col-menu { + animation: pop-in-from-right 0.4s; + } + html.default.from-has-menu .overlay { + animation: fade-out 0.4s; + } + html.default.from-has-menu header, +html.default.from-has-menu footer, +html.default.from-has-menu .col-content { + animation: unshift-to-left 0.4s; + } + html.default.from-has-menu .col-menu { + animation: pop-out-to-right 0.4s; + } + html.default.has-menu body { + overflow: hidden; + } + html.default.has-menu .overlay { + visibility: visible; + } + html.default.has-menu header, +html.default.has-menu footer, +html.default.has-menu .col-content { + transform: translate(-25%, 0); + } + html.default.has-menu .col-menu { + visibility: visible; + transform: translate(0, 0); + } +} + +.tsd-page-title { + padding: 70px 0 20px 0; + margin: 0 0 40px 0; + background: #fff; + box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); +} +.tsd-page-title h1 { + margin: 0; +} + +.tsd-breadcrumb { + margin: 0; + padding: 0; + color: #808080; +} +.tsd-breadcrumb a { + color: #808080; + text-decoration: none; +} +.tsd-breadcrumb a:hover { + text-decoration: underline; +} +.tsd-breadcrumb li { + display: inline; +} +.tsd-breadcrumb li:after { + content: " / "; +} + +html.minimal .container { + margin: 0; +} +html.minimal .container-main { + padding-top: 50px; + padding-bottom: 0; +} +html.minimal .content-wrap { + padding-left: 300px; +} +html.minimal .tsd-navigation { + position: fixed !important; + overflow: auto; + -webkit-overflow-scrolling: touch; + box-sizing: border-box; + z-index: 1; + left: 0; + top: 40px; + bottom: 0; + width: 300px; + padding: 20px; + margin: 0; +} +html.minimal .tsd-member .tsd-member { + margin-left: 0; +} +html.minimal .tsd-page-toolbar { + position: fixed; + z-index: 2; +} +html.minimal #tsd-filter .tsd-filter-group { + right: 0; + transform: none; +} +html.minimal footer { + background-color: transparent; +} +html.minimal footer .container { + padding: 0; +} +html.minimal .tsd-generator { + padding: 0; +} +@media (max-width: 900px) { + html.minimal .tsd-navigation { + display: none; + } + html.minimal .content-wrap { + padding-left: 0; + } +} + +dl.tsd-comment-tags { + overflow: hidden; +} +dl.tsd-comment-tags dt { + float: left; + padding: 1px 5px; + margin: 0 10px 0 0; + border-radius: 4px; + border: 1px solid #808080; + color: #808080; + font-size: 0.8em; + font-weight: normal; +} +dl.tsd-comment-tags dd { + margin: 0 0 10px 0; +} +dl.tsd-comment-tags dd:before, dl.tsd-comment-tags dd:after { + display: table; + content: " "; +} +dl.tsd-comment-tags dd pre, dl.tsd-comment-tags dd:after { + clear: both; +} +dl.tsd-comment-tags p { + margin: 0; +} + +.tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; +} +.tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; +} + +.toggle-protected .tsd-is-private { + display: none; +} + +.toggle-public .tsd-is-private, +.toggle-public .tsd-is-protected, +.toggle-public .tsd-is-private-protected { + display: none; +} + +.toggle-inherited .tsd-is-inherited { + display: none; +} + +.toggle-only-exported .tsd-is-not-exported { + display: none; +} + +.toggle-externals .tsd-is-external { + display: none; +} + +#tsd-filter { + position: relative; + display: inline-block; + height: 40px; + vertical-align: bottom; +} +.no-filter #tsd-filter { + display: none; +} +#tsd-filter .tsd-filter-group { + display: inline-block; + height: 40px; + vertical-align: bottom; + white-space: nowrap; +} +#tsd-filter input { + display: none; +} +@media (max-width: 900px) { + #tsd-filter .tsd-filter-group { + display: block; + position: absolute; + top: 40px; + right: 20px; + height: auto; + background-color: #fff; + visibility: hidden; + transform: translate(50%, 0); + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + .has-options #tsd-filter .tsd-filter-group { + visibility: visible; + } + .to-has-options #tsd-filter .tsd-filter-group { + animation: fade-in 0.2s; + } + .from-has-options #tsd-filter .tsd-filter-group { + animation: fade-out 0.2s; + } + #tsd-filter label, +#tsd-filter .tsd-select { + display: block; + padding-right: 20px; + } +} + +footer { + border-top: 1px solid #eee; + background-color: #fff; +} +footer.with-border-bottom { + border-bottom: 1px solid #eee; +} +footer .tsd-legend-group { + font-size: 0; +} +footer .tsd-legend { + display: inline-block; + width: 25%; + padding: 0; + font-size: 16px; + list-style: none; + line-height: 1.333em; + vertical-align: top; +} +@media (max-width: 900px) { + footer .tsd-legend { + width: 50%; + } +} + +.tsd-hierarchy { + list-style: square; + padding: 0 0 0 20px; + margin: 0; +} +.tsd-hierarchy .target { + font-weight: bold; +} + +.tsd-index-panel .tsd-index-content { + margin-bottom: -30px !important; +} +.tsd-index-panel .tsd-index-section { + margin-bottom: 30px !important; +} +.tsd-index-panel h3 { + margin: 0 -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid #eee; +} +.tsd-index-panel ul.tsd-index-list { + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + -moz-column-gap: 20px; + -ms-column-gap: 20px; + -o-column-gap: 20px; + column-gap: 20px; + padding: 0; + list-style: none; + line-height: 1.333em; +} +@media (max-width: 900px) { + .tsd-index-panel ul.tsd-index-list { + -moz-column-count: 1; + -ms-column-count: 1; + -o-column-count: 1; + column-count: 1; + } +} +@media (min-width: 901px) and (max-width: 1024px) { + .tsd-index-panel ul.tsd-index-list { + -moz-column-count: 2; + -ms-column-count: 2; + -o-column-count: 2; + column-count: 2; + } +} +.tsd-index-panel ul.tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; +} +.tsd-index-panel a, +.tsd-index-panel .tsd-parent-kind-module a { + color: #9600ff; +} +.tsd-index-panel .tsd-parent-kind-interface a { + color: #7da01f; +} +.tsd-index-panel .tsd-parent-kind-enum a { + color: #cc9900; +} +.tsd-index-panel .tsd-parent-kind-class a { + color: #4da6ff; +} +.tsd-index-panel .tsd-kind-module a { + color: #9600ff; +} +.tsd-index-panel .tsd-kind-interface a { + color: #7da01f; +} +.tsd-index-panel .tsd-kind-enum a { + color: #cc9900; +} +.tsd-index-panel .tsd-kind-class a { + color: #4da6ff; +} +.tsd-index-panel .tsd-is-private a { + color: #808080; +} + +.tsd-flag { + display: inline-block; + padding: 1px 5px; + border-radius: 4px; + color: #fff; + background-color: #808080; + text-indent: 0; + font-size: 14px; + font-weight: normal; +} + +.tsd-anchor { + position: absolute; + top: -100px; +} + +.tsd-member { + position: relative; +} +.tsd-member .tsd-anchor + h3 { + margin-top: 0; + margin-bottom: 0; + border-bottom: none; +} + +.tsd-navigation { + margin: 0 0 0 40px; +} +.tsd-navigation a { + display: block; + padding-top: 2px; + padding-bottom: 2px; + border-left: 2px solid transparent; + color: #222; + text-decoration: none; + transition: border-left-color 0.1s; +} +.tsd-navigation a:hover { + text-decoration: underline; +} +.tsd-navigation ul { + margin: 0; + padding: 0; + list-style: none; +} +.tsd-navigation li { + padding: 0; +} + +.tsd-navigation.primary { + padding-bottom: 40px; +} +.tsd-navigation.primary a { + display: block; + padding-top: 6px; + padding-bottom: 6px; +} +.tsd-navigation.primary ul li a { + padding-left: 5px; +} +.tsd-navigation.primary ul li li a { + padding-left: 25px; +} +.tsd-navigation.primary ul li li li a { + padding-left: 45px; +} +.tsd-navigation.primary ul li li li li a { + padding-left: 65px; +} +.tsd-navigation.primary ul li li li li li a { + padding-left: 85px; +} +.tsd-navigation.primary ul li li li li li li a { + padding-left: 105px; +} +.tsd-navigation.primary > ul { + border-bottom: 1px solid #eee; +} +.tsd-navigation.primary li { + border-top: 1px solid #eee; +} +.tsd-navigation.primary li.current > a { + font-weight: bold; +} +.tsd-navigation.primary li.label span { + display: block; + padding: 20px 0 6px 5px; + color: #808080; +} +.tsd-navigation.primary li.globals + li > span, .tsd-navigation.primary li.globals + li > a { + padding-top: 20px; +} + +.tsd-navigation.secondary { + max-height: calc(100vh - 1rem - 40px); + overflow: auto; + position: -webkit-sticky; + position: sticky; + top: calc(.5rem + 40px); + transition: 0.3s; +} +.tsd-navigation.secondary.tsd-navigation--toolbar-hide { + max-height: calc(100vh - 1rem); + top: 0.5rem; +} +.tsd-navigation.secondary ul { + transition: opacity 0.2s; +} +.tsd-navigation.secondary ul li a { + padding-left: 25px; +} +.tsd-navigation.secondary ul li li a { + padding-left: 45px; +} +.tsd-navigation.secondary ul li li li a { + padding-left: 65px; +} +.tsd-navigation.secondary ul li li li li a { + padding-left: 85px; +} +.tsd-navigation.secondary ul li li li li li a { + padding-left: 105px; +} +.tsd-navigation.secondary ul li li li li li li a { + padding-left: 125px; +} +.tsd-navigation.secondary ul.current a { + border-left-color: #eee; +} +.tsd-navigation.secondary li.focus > a, +.tsd-navigation.secondary ul.current li.focus > a { + border-left-color: #000; +} +.tsd-navigation.secondary li.current { + margin-top: 20px; + margin-bottom: 20px; + border-left-color: #eee; +} +.tsd-navigation.secondary li.current > a { + font-weight: bold; +} + +@media (min-width: 901px) { + .menu-sticky-wrap { + position: static; + } +} + +.tsd-panel { + margin: 20px 0; + padding: 20px; + background-color: #fff; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +.tsd-panel:empty { + display: none; +} +.tsd-panel > h1, .tsd-panel > h2, .tsd-panel > h3 { + margin: 1.5em -20px 10px -20px; + padding: 0 20px 10px 20px; + border-bottom: 1px solid #eee; +} +.tsd-panel > h1.tsd-before-signature, .tsd-panel > h2.tsd-before-signature, .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: 0; +} +.tsd-panel table { + display: block; + width: 100%; + overflow: auto; + margin-top: 10px; + word-break: normal; + word-break: keep-all; +} +.tsd-panel table th { + font-weight: bold; +} +.tsd-panel table th, .tsd-panel table td { + padding: 6px 13px; + border: 1px solid #ddd; +} +.tsd-panel table tr { + background-color: #fff; + border-top: 1px solid #ccc; +} +.tsd-panel table tr:nth-child(2n) { + background-color: #f8f8f8; +} + +.tsd-panel-group { + margin: 60px 0; +} +.tsd-panel-group > h1, .tsd-panel-group > h2, .tsd-panel-group > h3 { + padding-left: 20px; + padding-right: 20px; +} + +#tsd-search { + transition: background-color 0.2s; +} +#tsd-search .title { + position: relative; + z-index: 2; +} +#tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 40px; + height: 40px; +} +#tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: #222; +} +#tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; +} +#tsd-search .field input, +#tsd-search .title { + transition: opacity 0.2s; +} +#tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); +} +#tsd-search .results li { + padding: 0 10px; + background-color: #fdfdfd; +} +#tsd-search .results li:nth-child(even) { + background-color: #fff; +} +#tsd-search .results li.state { + display: none; +} +#tsd-search .results li.current, +#tsd-search .results li:hover { + background-color: #eee; +} +#tsd-search .results a { + display: block; +} +#tsd-search .results a:before { + top: 10px; +} +#tsd-search .results span.parent { + color: #808080; + font-weight: normal; +} +#tsd-search.has-focus { + background-color: #eee; +} +#tsd-search.has-focus .field input { + top: 0; + opacity: 1; +} +#tsd-search.has-focus .title { + z-index: 0; + opacity: 0; +} +#tsd-search.has-focus .results { + visibility: visible; +} +#tsd-search.loading .results li.state.loading { + display: block; +} +#tsd-search.failure .results li.state.failure { + display: block; +} + +.tsd-signature { + margin: 0 0 1em 0; + padding: 10px; + border: 1px solid #eee; + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; +} +.tsd-signature.tsd-kind-icon { + padding-left: 30px; +} +.tsd-signature.tsd-kind-icon:before { + top: 10px; + left: 10px; +} +.tsd-panel > .tsd-signature { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signature.tsd-kind-icon:before { + left: 20px; +} + +.tsd-signature-symbol { + color: #808080; + font-weight: normal; +} + +.tsd-signature-type { + font-style: italic; + font-weight: normal; +} + +.tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + border: 1px solid #eee; +} +.tsd-signatures .tsd-signature { + margin: 0; + border-width: 1px 0 0 0; + transition: background-color 0.1s; +} +.tsd-signatures .tsd-signature:first-child { + border-top-width: 0; +} +.tsd-signatures .tsd-signature.current { + background-color: #eee; +} +.tsd-signatures.active > .tsd-signature { + cursor: pointer; +} +.tsd-panel > .tsd-signatures { + margin-left: -20px; + margin-right: -20px; + border-width: 1px 0; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { + padding-left: 40px; +} +.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { + left: 20px; +} +.tsd-panel > a.anchor + .tsd-signatures { + border-top-width: 0; + margin-top: -20px; +} + +ul.tsd-descriptions { + position: relative; + overflow: hidden; + padding: 0; + list-style: none; +} +ul.tsd-descriptions.active > .tsd-description { + display: none; +} +ul.tsd-descriptions.active > .tsd-description.current { + display: block; +} +ul.tsd-descriptions.active > .tsd-description.fade-in { + animation: fade-in-delayed 0.3s; +} +ul.tsd-descriptions.active > .tsd-description.fade-out { + animation: fade-out-delayed 0.3s; + position: absolute; + display: block; + top: 0; + left: 0; + right: 0; + opacity: 0; + visibility: hidden; +} +ul.tsd-descriptions h4, ul.tsd-descriptions .tsd-index-panel h3, .tsd-index-panel ul.tsd-descriptions h3 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} + +ul.tsd-parameters, +ul.tsd-type-parameters { + list-style: square; + margin: 0; + padding-left: 20px; +} +ul.tsd-parameters > li.tsd-parameter-signature, +ul.tsd-type-parameters > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; +} +ul.tsd-parameters h5, +ul.tsd-type-parameters h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; +} +ul.tsd-parameters .tsd-comment, +ul.tsd-type-parameters .tsd-comment { + margin-top: -0.5em; +} + +.tsd-sources { + font-size: 14px; + color: #808080; + margin: 0 0 1em 0; +} +.tsd-sources a { + color: #808080; + text-decoration: underline; +} +.tsd-sources ul, .tsd-sources p { + margin: 0 !important; +} +.tsd-sources ul { + list-style: none; + padding: 0; +} + +.tsd-page-toolbar { + position: fixed; + z-index: 1; + top: 0; + left: 0; + width: 100%; + height: 40px; + color: #333; + background: #fff; + border-bottom: 1px solid #eee; + transition: transform 0.3s linear; +} +.tsd-page-toolbar a { + color: #333; + text-decoration: none; +} +.tsd-page-toolbar a.title { + font-weight: bold; +} +.tsd-page-toolbar a.title:hover { + text-decoration: underline; +} +.tsd-page-toolbar .table-wrap { + display: table; + width: 100%; + height: 40px; +} +.tsd-page-toolbar .table-cell { + display: table-cell; + position: relative; + white-space: nowrap; + line-height: 40px; +} +.tsd-page-toolbar .table-cell:first-child { + width: 100%; +} + +.tsd-page-toolbar--hide { + transform: translateY(-100%); +} + +.tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + content: ""; + display: inline-block; + width: 40px; + height: 40px; + margin: 0 -8px 0 0; + background-image: url(../images/widgets.png); + background-repeat: no-repeat; + text-indent: -1024px; + vertical-align: bottom; +} +@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { + .tsd-select .tsd-select-list li:before, .tsd-select .tsd-select-label:before, .tsd-widget:before { + background-image: url(../images/widgets@2x.png); + background-size: 320px 40px; + } +} + +.tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.6; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-widget:hover { + opacity: 0.8; +} +.tsd-widget.active { + opacity: 1; + background-color: #eee; +} +.tsd-widget.no-caption { + width: 40px; +} +.tsd-widget.no-caption:before { + margin: 0; +} +.tsd-widget.search:before { + background-position: 0 0; +} +.tsd-widget.menu:before { + background-position: -40px 0; +} +.tsd-widget.options:before { + background-position: -80px 0; +} +.tsd-widget.options, .tsd-widget.menu { + display: none; +} +@media (max-width: 900px) { + .tsd-widget.options, .tsd-widget.menu { + display: inline-block; + } +} +input[type=checkbox] + .tsd-widget:before { + background-position: -120px 0; +} +input[type=checkbox]:checked + .tsd-widget:before { + background-position: -160px 0; +} + +.tsd-select { + position: relative; + display: inline-block; + height: 40px; + transition: opacity 0.1s, background-color 0.2s; + vertical-align: bottom; + cursor: pointer; +} +.tsd-select .tsd-select-label { + opacity: 0.6; + transition: opacity 0.2s; +} +.tsd-select .tsd-select-label:before { + background-position: -240px 0; +} +.tsd-select.active .tsd-select-label { + opacity: 0.8; +} +.tsd-select.active .tsd-select-list { + visibility: visible; + opacity: 1; + transition-delay: 0s; +} +.tsd-select .tsd-select-list { + position: absolute; + visibility: hidden; + top: 40px; + left: 0; + margin: 0; + padding: 0; + opacity: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + transition: visibility 0s 0.2s, opacity 0.2s; +} +.tsd-select .tsd-select-list li { + padding: 0 20px 0 0; + background-color: #fdfdfd; +} +.tsd-select .tsd-select-list li:before { + background-position: 40px 0; +} +.tsd-select .tsd-select-list li:nth-child(even) { + background-color: #fff; +} +.tsd-select .tsd-select-list li:hover { + background-color: #eee; +} +.tsd-select .tsd-select-list li.selected:before { + background-position: -200px 0; +} +@media (max-width: 900px) { + .tsd-select .tsd-select-list { + top: 0; + left: auto; + right: 100%; + margin-right: -5px; + } + .tsd-select .tsd-select-label:before { + background-position: -280px 0; + } +} + +img { + max-width: 100%; +} \ No newline at end of file diff --git a/docs/api/1.21.0/assets/images/icons.png b/docs/api/1.21.0/assets/images/icons.png new file mode 100644 index 0000000000000000000000000000000000000000..3836d5fe46e48bbe186116855aae879c23935327 GIT binary patch literal 9615 zcmZ{Kc_36>+`rwViHMAd#!?~-${LfgP1$7)F~(N1WKRsT#$-?;yNq3ylq}iztr1xY z8DtsBI<`UHtDfii{r-60Kg@OSJ?GqW=bZ2NvwY{NzOLpergKbGR8*&KBGn9m;|lQC z2Vwv|y`nSufCHVQijE2uRauuTeKZL;=kiiF^SbTk;N^?*u%}Y7bF;O-aMK0lXm4nb zvU~Kf+x|Kgl@Ro%nu?L%x8-yetd((kCqY|t;-%}@Y3Ez_m(HTRt=ekeUQ2n4-aRvJ zrlKaWct8JSc8Kxl4KHu+3VW1L`9%n~_KC5}g6&tFXqyKT-}R0?EdkYqCmQot47^9Z z6;opqR@7Nq-s|6=e6*0^`}+X1kg>CpuGnbpL7{xFTa|8nymC0{xgx*tI7n4mTKZNA znsd@3eVsV>YhATuv~+5(^Vu4j?)Tn`{x@8ijIA;wdf`+0P3$vnSrcWFXXc{Lx`1Z7 z%-n(BM(owD$7LzqJx)(f^Cusecq>OW z=h6n4YzSVM-V!-DK(sLT`!W~}($=O$9|ie`>_fpH0=1G1tiIFw($?~{5T>`74|p0H z``5=UydE)!CiFvmECW|s^TzG9*7pN|KknkVm3C{fEu30gffX&8iCm? zTFPm6*k%Hog`Q6JGj@dg9Z5nlAc6ApUe>;6xauB0-u!?wMU92jVL|3EcP9gEu5^wH z%tXRy#>HCEs*?KgMf73UcJ!lJ?x<6+)eJ{mEIS|HMDP7(7!(< z@X;?ACT8mncW9*XIaiJPW}Mw@b0W||)!sYnLw)0j4&-rXQgJhnQ2?frg1Nfk&JpmV8F=dDZl)e%#Grs|&0th7_o) z?7hQn<1078qcq?#;)CH=2kBBiGt37EtcXfpTXtHB59dr9=B~jI`yPm-Q?(ys=ajAu zGY;eS^z&WFvztZI3I~}*l}_lI^}6D<&CZ94;|&G9_pMx!C~$~EL4^8`QjT#|tqxxk zhl4CdxppbDiOk!Ht#SVAK4gf6Cr#=U&1sVxZ`y-X zTSi#@wHf(?(Dd6ypNOyshRZ*tneVP^W?y?$ur_!9iD-vY{&Q5(ooX2;`SkUjwEYA~ zwGcylCT4_`MZobm(0v$U(IhfYXxyjNJ@ztpH0sDmfpn|LMp3eM(R4uqKi_q1=D1-d z%GdV<&2+_9k@sc44xhIjqktRA2!Su|vzM0R-@#MK&{RdLoU#$Hc?{{JItvX{hKCtc zQNqZpkfG^@LGJRZM4H_>`F=N;O*+_`>M_ko_XWCgu@}ntqLX8VSeZQ_25Z8|^!d?o z$~}~9|`ZW9d_o<=8&K^~;Cr08b;qgq{(*e*sNt00lO2lZ;m-b<`Rl}=Lr6iQ8+$&br z!RLn{5a}j1Dh^|_1)Q?<;iBSrS0V|c_D@3}mc2d!%tV1VN?BC@clkFdx?HB&9KOTF z)9eHpmUEYsCqx^%JHuNdwY zz9P3oPYuTAXZVY}LRp&2qNl$pbsXL1GJ@wx?@CTO!acs+OFfW_U6?&As-(GJED}RR zO}B+Kxph7aUUm>i3rbPZQGXN}oQq;u`yTnFDAJ*d$4gjEJH!JPyt6V{cOUp*Jbyol zE$8wh)T=vpJOWRbv}HvR(cUSlO}ePIPdJ`J@yp=IC&E6K%r?QfW7F&%p!H~@?%yj5 z&MpiV!hyfukD56A097f!0+ANt`JSB~oLak75oKQN7FH=rQbX#Eak37|4&mqp@S~TA zOo51)xQxX}5NQ(3I_UeR4B;P0Q#x$_lDce78ET`Blo;`Hj*R;b8slZS7Oak(LjDuE z3z?-~-U@vWe*cEOsf^9|duH9};Pe)!=Ky+QQ!jr2VV-jMUH-F>oB>Ds zDJw}jm%V?OT^fu1y`$`yRdaW03L?)6vmInxhAsGrPhWIP8?=speMFf9Inn4^t zs$!88*B~c1A2J6t0~hgK2BJ_Pl23l=oeQQqjI2(4Mcv6U_#9#$PEN|qz36rCZ5$@I zNF1LpRe%ZG4qwuYr7ZdaynrPs?spt;9VbQM$462zbksMVhAOqPunrR7@Nbv#5;VKk zJB7xC?~QXd(e9REiLixHxRGhLcKR#0va}|LMS`AXKGOIGFKQv?=+>zf^ zN5XLjX6^`zh*%1UG_QV1H`@z!HZgC+OT2`+_B( z)J95hk;3C+K4XCswSP}au;fx=47~*$k`RAaYEU-qb03y0#x|&>LAeiXgri5E(!h9k z|9OVt@sk1-4+>0?ELyw|zs`~<95M=%o?Gix$?8z4Gz3Kpw|b>?BcD&s{X)-aXg!GJ zyq&`ZEP{K^u7ActXP$gGnO#F0Sr+QUZe0&d5*Yhw9A?C4(Sx2j3QKAlUpkQz7nji^ z%y8F|W{ypj(T%Bf#Wgyvq4szMo?*U-;3IGBRg1fK9!h-=YRsZ_+t~2!-)=pr;)Vnk zmt95&wMb02toOf`I9>M^Kv3LqKb_-#jauF&cGrWsCnMt?p7*uh zevugda={D04DB#7wR375=1i5}Z9fi3r)!F#7qmX9`SjppE&%8l8bKt+ADRMTWRv21 z4L&PldV8YpHw3b^`p0uWlIm#J&K65-y4lQW0VzZR!4#gfeT{b#fL1e*)Z*Ux}M^}bO%OM7uXip_4! zL@yo@q{utZeVV?3CtXs}i>nI|%26fwuzt0f#96fQ!{=dEX^YKnvIk*D%y9Cin;9R) zi{?)baJhgFs$1$SOZESTpldw2H&FD=v*v@1cA!`|s;avDKHa>Q+uJ8qhy!9%C4&lJSTN4OeydYOm4S?Bj7*e{xRYbU9Xos)R7qZT3dBBD5{ zo+(E3pR{>>)}hFhE+}!yYP0V+CVhyAq+RV{^X`XA3{iXj(ir$k@u|t8ZJ1ZnHq2dd zD$0RHmGJ=!?T5`*T2zOEJ~y}Nsyt7O)%+!0ulRQdsopJJxoznfpusv=2@zLXIq@^& z>0T5k4lzGCG(DnltLIe@6=ZOG@C(dvmYXfh4IhJfMfY8S?KkT znb7~EDE}Yhg$J1LxB7m`L4VMS(+(SXTQvh_mz!x&M3-6Z zFRB*a%_gVEqI^mL5|c%V=l_oi%|~h>gL0SB4QH5uonWd#={KPg6}6ES)zk0~#3^KJ zJq@{iqbHe3gyC))jeQ`W;(u3|q)JxuF24|GMsh%v5>>VY-bok%* z1Yl@(5G2UCK=fQck}pAyWV0n{`ML|rsl_N7vmW|frii__zB;ozrQ7{z)y}M^Sg@m_ z;+?{q3sUZs3WxnBbp~CyyL(TA?C*0KIeDPp7w0$!Ijd+M8#}r~vYW)NB*$mG*7-vH z@s^wK07OMxq>WveCEQFQ*p&2gjD1j%i+#G9z##Th`gew>H5=`RwyfPDg2G%f>x3@c z14Oy}pQK?(i06GWLWu%4cGjDoE-tTEI$`9^E?nLT663vu_>6K1e!N>A-^q&tfl$0& zy&>w~+yUelAa!c@xd8iyt^`B^$cj+}h}0i!40K2Ve1KFCDezBzZO8@=k&r)`TNTJ* zzF4Pim>SYL^=~7kW>EyiVHXNMT2)8l#v^IW!pLB_8ZvVfK&m8QHkjsZ)mvd?o$VYG zX#HiWwWlW>N{D85URJ-d)}_3h73|)X=E(6hFzi#TF{$4aSka4TeY>1a_(RIkFBL#O zE0_FoSQI)}+si51ufAqRHhDU=actTRQl@y#2h}xaDv-A&GP&0Qu9V4ED5aWnX z1E#mRT1QSvL!4~%Ozt84nP{&F>VIm6w2q!EPhh^BF-94$4JhCTcrdbDXA3Q&8mPTh zqdPv|X}??B?bIZPpl}z%(zr<8U-NoXjb*L#xyqHHfpIGAgN$5i(E9#rYPYq_tISC4 z2TDkd*uZ;CIhVI2o!||T)Kz`ER@%rTf-&SfmJFF>;d(RW(B6k!1<)uxHM_1G+9BWe zc)k`gBxYMcztqY5@jccaU)CqQ@^G5TBVx(nNf2}D@);3+{D)GzyT{>%dO6ibggS({N!!=P4=M8J}5R*&fgd(w36z0M0D$ z(SN5a`i%sZ9vmaEjiC4)DF}ix&`?mc-vYwK@+}8Gqzj6r6y)lT|Iqwlpj(LXqvh;- zb>jECiiOZ%&Q7gQg7(ix-?-RE*c(O6NG0F-+VCr;701@%L~fyfHnU<;Vk`m3A2{1MSmpii@G*k?KDq0GdZ)|hd`8OHep z8@6wv_|9NKNpe*sc#?zZ1S#}*qk{k<(I99u6(QT#>wf9w^u9~9_>;2d20T=^g-;b5 ze9x~fHZ-JL=J`hq-;W{2SgN)&m9RsVo=%?`JYp`pxEA_>`18Y>XA$rfWm^pQfG3MQ zxT^I1*({tZz2}+!5$AyNUE*jiYwu_S8v<#qZS4e!bGGBdY`3RkgLMf%Kz8s-;7PF+ z6w#-FwV#)PiKGR79miXmrDyv=ZTjc)j>N=&h4F+#G;unBZhhZz?a*;8@bi5`fV4)O zuU5pCs;tvRzbV@P5%W5xLI4I+w*^KExeVlzP4kNRGp-wi3g$lf-I|(o`JQ|u^XfkP zcik+g-5~2lG*oHfjLCpfNalFwz=4ZY>$Rc-QGpws&tCfFZUuJDL)3et%ap*$Q=-v0 zgLfsn-&%#+wnox~@)6ppx30sK(UJg1dCAvQF&}DkoPI+uX_wH))iaYvWtl}BtVKpU&MN= z0GdENbhdLgIwL-#_phGK;mZRlk4zq8*)akvV5zRX@jFUmvcr#3p99P@4z@m|bz-)^ zbZl8Wt?hR*z(sEZl;2PaILIG#835i@YoZQ@EwrD9IOBl7BpJX(ilLgcd)KCZAzo^b z6Z{|~=H;$D2dD53tejr_jx7^y-zT{SNZpNjn4+wJQX~K#LcrlKOv=D5xk%QXD{tg; z+xh`PvMV*HC*rF?xyjK5@KsMl5*w`r@wL#r13uFpso~#^oYIFc^&gGNS825eqFttU2_sG%_ z;X8VXD#Ol4X&$2B_Z$*&-)ZIUXf9I%mOOXJ3O%GbGpJfl+9(jY^fF_(b!Gt{{HAA3 zusUOCPDHYT@&*H~7a050c7r-_CaFACp$BXx)5==@fC11Gn|n~~+u@6N-}lvdyl3&6 z<#c_zm0Xp1F!8o2OBbFfgzzC4vno}9XEf40dGaVo;jiwiazo8hZ~iPVD(re=5k;H| zotm286$6nnTeIw>1FY$Ri|t{Lp?o(Fg3g_>|y~Z+16tvyLc@r?t9g7 zBuXyVuu9bC#q`?@OFIhgS)6v^XP@H0ukl2X!RPMsg%`YHMGad z4{VsgxaprFss3X%HbZablb6IdaNdbISVWp7yQXPPn=s7?J9qLEH{4>XAv8}%h&TDg zs()1sh}4at3nL3^%q!?P9BbW80e*ZwU63}CV7pt}gVu;~V6c$9p+*wfhw!zeE-z|V z=k{Ksec2)$Hu&?pRh;*TPk0T$Fc~^oAoBT4q?-Q}Y&3DluXeoMQ0LesTk}pVlf5(I z$dl8;zA0&=L&z*F*H>W7IeiPhTo@P0VTB~vyC2Bm7lCN}t7@NNlKFSHGKkh?z_qij zoYju!#D4b28cdslLdIM5Cmqe&!v^IcRr=qq^?l+P^n@6}fh@)IS81hx)SPAY7osk0)^ulqC1F*{hBNQl+Y}b>XjVXnS_Cc!L zIZ@Jq#mp^E&fKT~t4DM_^S17R@YJ@`(7;zv1mz_Y=~q*Gdg#*yXGxotY=#F|lvhPM zjlE)VHS=8=)njE^c7M|ZiBqARx>9Ib!y91$70iC8jPi$c+ysP}5Q3s`ti&1sx>~oG zI^>^1onS%G`mtq&)cZ15dZ{X^#MOfatyH0I=l%Q)n z7*@kZtC_3?=J_}?_G@?F?UK<0_AhYFclyrS-PkfYhAeVHcF z16x+quy10*2V$A%p_|@C(vlf}j3uY83h(#TSr$(;^8(I={_=YQQWmA9-IlwJv>tQm z=vN-I{TO7X`;qBxwb5w$91YLV?ZD5}pddq(7IdMCH zi>`qAn|#FITi!L5;K!(tYm9r416}Wof}P8~?R9I9Gp(?VA;uQg19MO47*gS7fH*&jBO!+ zA*<^BMccHjJIvGHguBb4a`X z3aZw#!c&Xr8&szD1+gu&;vYfoWo>0Pxfr2%m34tC33fmRbzWF9I_Pqb9nNK@N##9_ z7K)v)des!^owH`MoXY_O?|;^9;comiPx0e78xhnnVvTYt+t+cU1rn_>gaFJsL-iPn)?<9P9cF#4)7q&v+d&6|3G@s-AcJy+m zE&u*GUaMK|x|4GmT(CgBICk`2BP@3rqtjKIRD#uBy}y*d;<>`?W&mGsG;i*_}V&^tlP`%;=g39@jxP z+3lrtg*!i6N;irOpUfKcd;iDl5a`<#kr8RwFm9=^m+ouwwjcXmTB}w5V#9IF^&Bl$ zr1$Ly#cQ<3u86>am9}pk&i%nxu(W&s@>qEDtn_xVtH-_EiQ}iAK4Ssfsdn&L9t=)d z`XOQN7*J)g$Jrtq0=-yeLnHg*23LxYA7$cxz^Yc)I6E-!;{LQwu_wfGw4&MYy7{n< z@{g0Hf)N5gAJKQ1Z&HGPn9x9B7U(m(9K&=+LHAc_D{YdMBZs~x)u1Y8|Oq!`C4(3_9<&$ddi6>R$Nsz z*ti?=jA-Sr_97V}feo+}Lq3-cfpgWR;PLI8s{ve9@?e;2o}0MpquOucipz^DrT}QH z*(<{nLb4h9799hx4&%I8KPj}xcQ}llgcaG1!nRb(PP?m)=CzA4v%6>oOe96H9 zv4mUhw`>V$29k?)$Co>qIqq(~3w4jJ;Hv5(RxjB-j_iEhlF;&|DDC|I8IcT>Vn;RY zhtw5mT0ygXAu=M%{^;GqYuYIMu4H;Mj--5CL}|zMEhOum_o51Y7i|D>$XmUFoe;@1 z%GsTUsKgF4w%-Cr3lg#~h)8;Lk%WQTLBS8r*sE{YBUDw4HU#o}E)8pVIEfWv&14?U z-+Za${OFm=>IA358en)nB5Iaqxw&Xi*ty@uDOX8o2c0tq0^sX>ZXD+Hn|;KY!Omm1 z^%wgf&Zy9Azd?vmU`~zuOOA0{TZ*mAC!_>|avcN83F#c+sFn_6tGo!v?95IUR2bL$ zlO(OlhszqAgy)mNt8PRulC#6u^SL#z-O&@{=_!AzBZ>T4ROorj%fx$A;u8u>saum0ha7p zeHRX-z)PW*@v9bruyAtVI@)PhaEs5kp`xyxTQ`U9$Whwz#z$=U$V|&0w@EfCUS!Ob zACSTE{VeC-0V~ZCpkKq~P4CLgdOeBy>vB+0ZxIt_Cp4aa%vI#LS^K}ui07WNo}5r0 zagMHmq-jqTf-OD<kAvu_ob1mUP%1jxeKqB!1&-)_hP{p74hHE%WM!atyx68j5b zSqwh8aKo|NIOL<2_eiX+iOsRP`{MUt{0iQetB*SL!F_8)_;0f$iJ4(o__4KWuvy_! z8TZ{dTb*rL6VmuN-yl2Z>0glL84u^jAH^DQl}VRI=x0CnuF*|;|My-5aPI;>(mo+m z`nyEOe&k$RG11$vEdDPG7^raBCw|#C*4#pIUoZJNx?4|ZC{)l>+jaSiiJ`GBKf}l) zUk1>%A61hqy!KvfRsM^|u6vwbH5WpfH(I5AdpBAg%rar%zW}nccGxfgRV4&v`tEoGyBq!uz^f zVqWEtxn%j&+Q2Fi$rL)H`M_HExP+?mFyN^){c{JXs{IM}f}p>7lfD zLZ;s)%6a(Ow@`(jP}k~pn@!dv6JhJkZf5UoumHv`g-tcCs)w* z#0sc%t9@Li{p}f*$vg$UiQ*RGZUr=ykDIaxRDU_(QfcURuYrpX*7IQcS$(Buw%VW7 zxaffDgn{-=K@iEh)LlPc3MPzc+qM^>RXr6Y8ASnP&dr6fqmwYILTpmh$E%{Iz%Qz( NZmR35l_G4O{0}dcmS_L~ literal 0 HcmV?d00001 diff --git a/docs/api/1.21.0/assets/images/icons@2x.png b/docs/api/1.21.0/assets/images/icons@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..5a209e2f6d7f915cc9cb6fe7a4264c8be4db87b0 GIT binary patch literal 28144 zcmeFZcUTka`>%_-5TzIqq$xo`r3nZ`iiBRG(z{ZnN$)K|ii-3S5u{fmRRNLEoAh2n z@4X|01dtAA(50@mzH5K?{+)CF+}EWTz2eMdW-{;n-p}WG1C$hCWW;pD1Ox#ad~k9g4`y4!oVfq@3c(iW~uhy*`T7_0aH7`>`EnYuXVq#+YC==3#rnNM4TqqzM zpi2Elr!3hl!ZdK#y0bV+yVc8rwFEtAX3=QlvJ&e-EsBp)Q`0yKXbNuf-yYw7kh0CD z|Flk1UuHgvoR+*QR0ee&IDUfUzE7*`A=P$6nC;BPI@VJs|F#`Xc>X!`<6%M7XXNok zw^unt1h0m>-&2{GiIGsByulr92XZRrazZs&&M3jJintF7A}cE^uW4zt_r81yHt1I! z6-_gmO@78G3$})kfyhR0^qk?zev_%4R$qSjQI3MAg0)9EM#TOAD=_tf(*)S$7yiiR z&5v>wk3Bn**iD9S_I#2%^vi(^O+gpv2i^A);6^AcH%VC>0nH8|O!jN*L<#RtT z@aF9HMNu*d(BdiZq(LBO%(qsjSot+ZXQd{zLYh#CvOrK(?#u+|XYRylqcXOLk=m!) zBp`~~1dg7kF(Q#m)I8ZHMOD5%m&U)5jGOW@7+sm1N+O~^j*zRG;e4x@OteV=T4yo9 zSG`^0j^S)ZYp2DT>}AR|n$S)4FPI#8#(R~;Y**AZ9`&yqT;p`rks7Nhz;)dn-TgXU zw!^Bo@W6|jfp@}ijsSEFo#x3LnG;`o_yXK@2KuG8cTv&K@=dU?_PK*6=YU9!Ix8l;<_!y*Qc2phVpLM}&t|CuHBv&{M$K?VXtTabi(7kUMwV zl!>5cDNNqK6`Br*B~EcVh#5Z!FgiJZBN5nzpC7?UdAc+&AT0ivd;DA2$@YXMPK6=< z+#U~?*!R0i`3uu|#zDrRRN&j-j>ZOu#h-n#7WO^)@0> zCT6a$LGWwFLcPfN=(3#6`*UIS%uIT=LIXV-RbGE&!!+8)q~dkx`l{aKCe1`{J<5&< zlhRo;JX-UC>5)X;mwR+W96`@&ucHp$jIb~B_w_=mH>In?BLume!Wta=`ca+&7~pek zBVD?f5{nelCaje~EtZn+g3%5GJF}R_b`q}IH$Iom2IRD$^h*R)Cid8Q5~4Dzm!P&Q z<`iI)4wA#l@TwjPL)*9k5Vc!!;`9;bf?HRMm86wi9LI8A%*NGep3g11H{aP)>%l2Q zRMMQU!*0J$hJI5Qs3b=6?}qR7O;BU%Yzufc*ZKBV`}ro7zm=C?OY6Vlabc^r6r7P> z?1c^jD{e4n*Ou441V=Pd1eE8utX@)G5gq72HQAXLZ4l2wKd@yIYC+s) z-mu`E`kj=B!)a^B;pecv4W5oh>_tpj>^NU8L*eH4EhcOxQ|);$x(z(Yb5^tudSptV z%8z{(h@_t`chWkvFX=r!p~Vjhf1AdM>uGK05$1fyLb5D7m0!MUKW=JTZv)bXz9~*F z$yP@U3UE0=$;yjWr8b7C(1^oNDMZVxYYeMtL}ZnvQDkm>S0)=r_ugabEZ}AJ<<_Fu z{I^KKIz+V8K|pK811W5r##z8^S*2fr9Ln zlRG?Zzz8;xu9VSE8s+=(!^TGi1P2hC7%7MUqF=cZqFBtJNW9BROV ziv0cjsUmVvsU^X!`1UivK|dy+fSG$3YH8W0`q${`)taBT9jV{Hfh|&RIaJVvqRIFh zC*Rmvl&3*;XcMiJZ-+Mvfe0xN4N?AvJeABnNdgs(BYb!fK5<1)5UvM!Tz4_aojmUX z#Ymoh)m%fN(>6|#*RP~Lxt1?5);w}yT_lftje3sidO&MxNgcMg9@S+>M%s~y)0i`8 zT_+7LrZ~d<7V^K^C^~ast~@nM04^c5dw*&660^p%^R>n4xzd&jo)Y@ z1r=F09>jFOr%wsj^a3;>N!{rvf(qpkAdWM*5IYCsuwNwoJh7;9I$#`T6-NUIEKsiS;OylQ(XY zQtCiR1dyEGJV=~|zaFOEveB&szAVx*wsyuY?hiBGWR{h0!D zv;G`;F9cnib*YxugasrI^%uy@i)>BvC4V8@! zwy5#iHC#Qar(i0EPA3CuMQbaKy4m$CLjLSNwJs!13b%h{&x7479bv{SjC&3?SO&)3 z6q4nRRP(zOfw-mQrmx@Z64~o}GNXa9YCE$vD-(CLseaF%6HH+WZz4 zbRiJ~zAtA6*i9;z!+zZ?9~V0Lr66|Ae;}U1e#6D^hMhB6XJNHZi{t>DgU&jb=#rPK z@s04Hr_SOr%UCRY_SdDuSw^D*Rzre~4PCqgc)DBYam}@G^TxsTqX%w-yWtYU-Q2IX-a2Z4Kz_-yIe`m;x2bY1F?XZoIH=`uW{$R)ICXxqU$- zG#M6s!fDZwUOA_cs|PXe1T@XN3^UdYyR*t}943A1dTvXp!=%8c%)(s)5y@OJ@@%1a ztlq}Uvhfo3^ZO>ZO|NKfu37JMRRmXfJ_*VOBVnxFFmbq!zc%A+R+w|={11?sJpmca zCeCi;;-*yO)ywzKxa#q?E%@U-+LGH4{=2|reRd-Kz*Ps1$u6sPFO>{K9^k2Y!@=h7rZt472^BCU& z|0MZmbh1HlC3#bcjoX#m73R?H>6oW=45{gu0$S>j`v?``ch#0kGur}QbO_gO3XrB- zS4pz-Yrnqqt-k_LE-&~ox9gd#^n&HE%Z~grM;N@Das8-#U304PA$v*rj36j~qQzYN zsX>8?%q9DhpxrWR@M>30YI^WUDh4bcn+*bYn;~zt_g`$3{#G+=lBmWE;j}5e&vlDa zjsdE(Xg^o(Z|3$Tx>~-q5NrZ}^$y0eMd|h`7Y4OWkgF0(Cu&CfJV03AKfzSGBhMU4bqd4kc`qE!CH4Q^FdOCtUHaZW3R&>S}$! zhk=OYL~3fch$-?wa0)OEkynDzJR=vc^vuUQ$hF(>E(q3{7{4uhC^f@bzHUZT>k%%R zsekA}E`OlGE(x+lP1smp0;Ba7{C$F=@Pp~i$AsJkc)x+3Vf9xQB=aSN>D!T;Y5iU~39#6yoQuj6Bj%kdYC z`72YjnSoF_A)d#@S`|;~F|6TOn%b{4?MWJC4uG&NK=D zqd0rU$A@62MtWD$=Gg>TgO6)b6Vf41#Au&Zq<@p1RG!t}NG8kv#>%{bHuCdAeIao2 zkWX{dyO`XCdv`FlK?jS{48~Uaz;oD6PtoFF0u6HBTHCHh<)5wP<r?9UIw%{psu)`l~*PK0?1^oH}d{D_wF{En-ejdBHTK|(*2$K?xVkG zwYXl8^HAjVOqKQj0f6s~O`)Slp+alXd8@#4Iw?pHys|MW1|l%ipCPeN)|fLB$Dc(9s}LNw@?8G{ zU>U(Vid5}ltIy~zNv>o09)rC()g8O`<5~!qF*Z_?L;+2Sy!WSv=}|67mnOPb!A*2; z^f>okkk+f3+9?Tg&6NBMX%;BtB3Ds#(PZ6E4`X0e`~amc=9QGw3J-$!nw6)l1A8;m zFdl>D?g@J3P-41+3N`R32d*Hq0GWj!{3n&rVA)dpcB+|5`XZFFZI1bKA7d;-x=0wt zy;$6nvCJ$_&JDjWa%`LQYq&(6LqBP7G_+`+4$|qk7IlS4wK{qnP-3!yFO%_fw(8(Q(#|htD?ECEYPeT&anf%0GjGQC<0)vR3x=4pq`@gX z{0?*O(e3p_zu@N9G2O%!F8j&|FRhF(c@BWMxZTpdW0xv^K!`2L39%+Hs0#R>a@n-J#u*kF6~?DIhPrUi@$pR0tS?5wF%PE z(-eYCc#{7tVRzd>j~xO&LBPK62xxwmxrdd{N6!G1hfD0H?fV)_B^PBIm|@~CZXnpdaM=<+?&D8Md^RL00JfP zK|cm@`4bB6muuN!Zck2>k+wh^8kM73#1(%6#^TG;42H{?eTC(h^zB32g{Skc%t3Dn zcHX3$TQhR}n9xXCd$?igvlBH@ZU~p4OO*Gf=$@=w?9vYs)!RYa9V@}xVt8Sr4y_!< zGjn5?gnlSKhqS-YW^o#@NScez6I3x{ zv>meTLLYSK!pa+|kqQI8rWST7_)jL~mqQ}Ou*!V2U-g|ZR+pB%Z@w|HnZrV~uY*w?_gMhSp+4fY?hMmdNXYD(iruAlj0&qga8nQ1=c#y* zgYc@oWp>=|LQ+s})zQ5kv*UF?QMJ2|FN1CzjX$x&TwGJ!4VjOiZxVDVz#r28{^WRn z{o1SYRs*^Nt9(ZX`wad=44v--X~h#aROW$yKE=n-VWRfhI&wn|_X6(` z_WPK(bt4Q8gxJ=b%BW_nNj&h;H;2z`{vi`~)tCBk(zGYBp?f;(Ua+^@+rKm53ld9S zPP#A^Wv7>F7c36IAp7(%S716|mr9fnL?n&Q*?OcmX7>@shP*98yVXmJ{1{z!s;@_D zt0}M~j-0t@?)wY>a9PxzCVtBiTKiS1<;-&hv5CHiv=8d$IOnl?aI_>zR3eW}l*}`T zd7%jWK1w(iqAjU37u~dz-4@O^=PWhD7_yL+z1;-hnPx|je;QFR?I_x6McEg|;`Zuf z_}_7>V@hb=%%^H&>8W{N&Ud5bKD%p(B6#&l@nN^wOdQizb`@g}g1c|qGqGr^c>a1w z|5;G!BbS8(8#mlqM+re6&;L0Ba$evPxRGW!koG@-z@*c+8&^U^7Q+0jgUtgB$)Bh)OGD5oa(ju zL&w{}@q-4qVXtvRtXul%gWH0DxXe$&?MN>z2jh1!ElU%a2;fz@xaTyfs`lnr<` zLv5teGAw`KJIh))Wg8JzoRNMyP>X1rhr)=#Y8O6Nf7>}xLS8!@+&6k0h#H>Nn{`&~ z<h^0MI*wtWWT)UGMw#$-to|sCF?yXL$;_=8T>RsAI7ks*W{$R-UI&M5a3{Gda?9J z3PeWSws3vp1$(`F*+<1X7B6hG<6u)lqr|?N&1Up;Si*MeoRFeRNGZa1=`C?4ZaPvJ zuHL9EQ^d$jd1pu9n6iBgWPMtJyxmfJGQf{a*eag-%E@KZ$^*2_&F#h|LL)2_l*QS9(#5T>)&wtE8a=@FF+vG8N zk>*kU^97;}tRP6EGf5HKhlr6@^Nb7N1`_>QnnYF9-8tncspx59kcfE)TtFun#cCjn zEU2;}6Xu~xx+Bv+O;tKLcuo?~kQbcPghcWdz4-^H!wQOhQukRZRMRk>kfMa~V;A;p zSqpR3D87(4X}j4Awfr<~7h4dgK)pzpZf{bn z^yt`yH4+85n%*$3rL0fWi>l^4|J{Qess(a2+0W-O>gl%xIaVi`l9N3Nq}{$Q?o$#6 zP(6};On20~O*x}!V+=9YO)zz4yeTv@_04tEzA@Muc((5aTR+rHpa6@RymHX{a%Ss{ z+ZVey@TSCpCZq6G3WNWPfd3Z(|HlaUnQ37#)!hnd5VH}%lQbK+^qVrFox87bV{eTd zMjY@0wT+?ndYzV$vST&K{gWpow&Zbq;%=a$(B%@MLh@v!P|L4U zgM9JBN_Gb)g+}3@K$8-*b+GGuC&@6v)Fomd?4){kVQ)620*%U<8saNfLM+ndN~1z> zV$;~rU}Fc&M@|;i!@q(ZqbHdoB(EYYOs>u5jd5A-M`}}pr;g+_B5o2kj-|Pa zF8qc!e5d+kUV>;ih=57(*r24g=6@)>+c%LfGLw_-Bbm7r_`az+tag}5rqG&jrg(-W~CJFkaxZTf@_Ofx@ zzxqF#<4|HKKBpc&B9R1r8t{!k_=WNfzbR?aogs939=bT|!c4N>91ai-wsc4|JdG9y zGpB1A4i1ueuSS{R3h}0^YLpx`pB;Ok2-R5 zZzHya))4+|xc0QJ*&1>3;@0$RcgE3M_rt55cZ9<51j!pV&i`8js3v%e$CG{I{X+yj zruhC$iN%UA-Y%u_?FQq!rBg;{`8h`ZCg^bG&OC=733*%4cUW`DPGqp|OgNy?)-Lky zuY7>yw$@M~Jl&X?9MI2RqOdsWZwzFd6{P)UF5-=GVh z;$}}BvAUMs#V{T@TweGxI7dhuIzFqotm&oQreos6)^Nt1G4l8ce%&u1F<%WFM9t;W zBAEtq#1FS}e7Gq{9nzJ-0@1fhx^+w)&5)h+@I@?kv+h4xs>`xqTMB()kR)QH0W6ODL=b|ea)CmcTzPItT=KH66{L4@p}bW9=F z=+(cM#QUgiq$M^X08=_kUPU7sf!8j#4rN7NO0#TX0-;8=ySO&T7v$C}*`++cHZu0; zRv+{Je*j9;z>+TGv1i76Qc^1lu^>XXp&w}t;MzI_nTpY_m?O?J|UF!?x>j)zIZZ*}uTg|S?56^~@P4iEAwq#7&c^D#OmVAeT^&ib{UcAER@k$$X; zQdR$NNz=G^;6|aY!VuP>0e2>_I^ymyjmC*~Oj(aU>lb7XxoNc&mR~HbdffiYw#m3DLJ)nb-vczmSGI=PaP=yOJ4mrW01pSsP02=(ym z!R+#8VFsL>Puje-hBZZ0gY`?oFt44R6Z--pJ~w8q7te$W<+z`WB)mKtrOR>%f~{*2 z8>hh;3|%NPQq8-xDbWw`*n5*Ni7GB0zr7D?q`b1s^a4*X%Jk>EYA*r$va{t*S$Wk8 zL^lqaL9$a?PVadKA#e`-ocbsFKC1awpXsVmMxs^Fnz9Tb*6tD1sa`;k~@OqRo@ub(|hVwu)j^O#EQmIetE!ma(-|!O<`ZRqJb<$^dia$W5ARK;F@n)=G zXY|L|OhQ88G?ay6&;=(qqYF;O$NJ7x1?PPHYJC`UButfql;CF9^Z@N$9e`rgvKY7- zzkY{r^gSjplQ4S;+v7}YOOB)q;im)xJ8Tb}^>Fe{+E{o<&QW1zc~g`vO5=ii`UUW? zZp)~%d!YRLs1P5Gsp1zs3gc8)u&mU&?P*XcG+Tr-__K7L+$}7WQfV_Ngi(tq_9feK zK+m&sYg9Dt?NYYIX6$uOy3OW4i<~fWv+Cf(7LSO2Cy{IK;1#Y8C_5@I{l+TY*=I|v zB849$N`$Qn3)Wezrk#N{(Sj^ujO*o{#sa4oD_O8zmLim4B{5HQWLd}YpB(b z4G-q~15C`KQcuBSO|^7AHPTM2RneHT?`cv7UxhiJ{_{;Q;kGe05x5xg&K3|_>$pD_a&U>aXaI13$(JL50d8Z5nu7>Swu zA*$V;mYnn2)kI5c`a29y*`L60#8U8YzlVb^NVbZO*AIlUcC6{g-vYStoB)oYa(>HrRpU$_+Fu$?E^-+?mgq9i+l>lZ?b zT6(Rs*ytr2RlqzPAC<(}aFaO~EuqFiP9Nk%5YV?9#t-?A=4jtCuRhpfZRc5{uXo+q z=LI8vUYPpMT}NAmAiT1T|Lra-gEjft1a;1k`{Oe~KvJy%Wz~FR@vzsl)Hj`G)zsap zD0(^YuCzHguv&0Ryn%gl!eek+ywQej&`(Qef(ql7EcAYQoG}tAUY=Ns0uhUO05V)*ND z@*NLrHqhR{%JlU-nMJbBbn#Q$0gDOt;1glG|M6dhX@zoq#PRvcMk<`}n-dBYPlDbf zY2&o+<&J4^>4Q557tWSxa)1M;mS}X$!JFe6+N_0AI?erp9CdjDGuyvnelpc04y2u#n8-PU5wo6P&9?ZpnONA+t}Ucy z&nD(V>H%M8avRC7jdV$uW8n|L5W6kw7|(e8$j>_ZLqe`6y!1fWM}{tJ3t7HmzB894QuSOpNj=&WDT3e5Or0)3wFwasb4%9_M@6)K z&l3J-@<{!8U7lZ%P!XZsO|ejU04NSjBEBESP4Ff6+T}!&pxTCxBG{W z{I$5gyC-P##k--2l=5r77AsRg@o4?Q7zqe%7Y9-kbSnK|KDcKK;nZqb@o$i(QzUtW z4FlkIku@T67|OO;)}XWaHSwT$i->~}#O|Bld^q?M%%`d*s2x9BKP zZo$OD?q27J1NAg#Nd(Fn?4I|PbI>nwdR&!F6YOHC^L#n$QG{zQGnjL8QL{~TyS%sy zMT%4c%BbJPXL6?WNg|O1-c<>qUm^=RW`+5)eH2jAI{T^M6-_natW57V(D?*MKT4n;I#vjkQ1Y~X{0hj4% zF}qYRzy8zJX(%d$`X$XgPvDafqM65Qw_;|~(JO*m8-*q1ir0~W4cd`@#KX3_GEp5t z5?rPAGz%$L?%(5dRFgw~R^|tdxXDGF>^=J2drvtC0;nBNt)$2d+>6A}c}i_~ef`fu zywIKq{Tp+H@09h2i{+Dn7?p7~8D%gZ+<(bq<1f|tL;Qy~w3}O7WX))3Ej+(psj!1- zrlt&tNKU|u?sySN{!ByuYY@P5bL5@7&Uld^k~iLzJaP7WDAI|JZrsHHT>hmAC?xw& zC!c!IBNTzL7K;wAXR3vVTe1i(oYdqoy3H0Zw{@>?*4UcFaMCNHwib2efs0(Ync=2q zwM72#(Cn=nv2ablw^j({)fdng^E-(uP|5UD8@CzqpKlZ^=HH}?5{kmM7vLAoAatc; zwH5KZJkkdhh8C1p5+HZgC}LE+Xu}KIn7|*#?;j-8^-VaZ5jOW{JA#*;g5p`(xTiDd zKkPnW*IU@QEsE%-JWbaZU2+aF3<-bfklBU}TCC{E-~c1suP&!}=v`e&X_xF{wro+L zcgxt?1af+ArOGprbI<(>!E99@GkN&7?#q=uz{(bMN@|0qqxcTr07b2;i>k6W8Za(r zOGe?77{mF3SVV_<+hIDRNdbE)(lSDJU|Bf|swOh*8)pQ6AizER8M>1xnN1+Qcqhg$ z&ak{6PD5v75^-mAcvoOH6*!9Hkzpt)*#Ip_vNoGk)^|nj*9+w7+7R(=j4q>aw<4Wc z=nBx)kd4$ER29&>bnknJ`n4)pOczJMPJ! z0)p$AgO&S=`T1(PYN?P}4cSJ%&R?iNexQp^N$*`-AbTP7WfZIW#P4d}}S2|=#O7ke0mzh*aEWQE)y!|#~iGCKXe zpzrFFL$pk!^d8pUI(IfGO<%TTQHsrDXLDNnMC6*d0wT9m7x6Ft7V=_OlTqkuj{x>p z;1kpB_NxE04RdYk)Y!laqUU=rfZJ$T5)`7`QV?5(Ltg_xlECcjtEa{J!@6Brx);>b zl?P)xrifEIfWi;~!Hgrq*7bz~i3BH#^2_mOIb$vnOz3yqef|S?NrX2~aMzcrlIGhJ zJ57YYnbrjk0gMXNJsZ;3!GV3+U0eN7l{dNPN>2^D{M%{F_n#@Jh)M2G9pb6tlT&F# zzc){OFWO&LCDH1cNMGR@X9VA+vt>EiQ|#sD{Y6sIh0eE(T5g#Bhn{L{CgdEL#dtrL zC>~e(BtwcN6QdM$0h>v5cu{@BvleO1d{z*-w8N(k$wHP$AXwvfT1)EL-?E&6nLdTq zFA@*HmwLR__b301zkRRgd(MeG6hCvppG6OwFv=2NKQVx_rQX$Z3q-DFDcOMHtbuC2 zb}=nSGqv$BlXjj(ahhid7ECVPglKaK;z#;LgZZ+OisWYuKBPX7xpErFk*@EYkKqg2 ze61oYkPXBN#&}jK`c6OUoF{pGlCOmyvi0VbqIH)+GaMDJ>Eg{$20?GwP~=nbph7n3wT-iS@IWTjG!q<-}5nJdNKFs75SDJ`2N60FM#00h+c!NU0ufy*_DlHj73t z5%X`Hqe$xxtHUL9%+{FK#XTYqf1a`&Lh=``4pOX3cy239FO^N zfStakz4XYa-?AppcGY?%Pj@WYmLvxBlKhq06UyFTy`Dj|YO2D`3uG#B$$f7PEjp~U zN;XAx*Xx;j?A}%@n)?=Uw67Bf^MPlLUonDdnT0whr^OXyCbtVRp^N&tL4I{~Dg4l+ zvxK9}?_3)Y$>n?i!054VsQ<#MMZ=Q@luen-sz=N_VC}l?`zNJtA`krH?K@>?REBq0S+(}^2UlFWDqHi30Pa~uu05d$T+-JrcJV1?aXOg(}Rs zl`@li5%>|PHxJjZT#h6)u5#ukqU%dvk;$HYi|x;L7naNA&)c1zj7(iIm+BYA&tK7r zwW0zwzaX`x0|CVQVi4}J(N#ScVIBUXBSyY%CN{!aH)SJ(GEwpFU}-yF{d#w05hL=m zqA}!Sf^U&%EPmu~34)ZMEMWZ|Z{ zf+Da%zhehlo-wY?=x^Nensm)O!dR`~B96^wloNE6>dRY#u#pQB(ftm&2{0{aPw);3 zLS~XJegtuFdsZ#-4}Yw<2z1ya*ZublDU*Ut>&i)(l$<$AW-E7gWuf>Kh>nR@=~Jgg zYVeI|2kH%1E@)ScwTRMO*HTWJ!AcdT*o-xoiH_PF%JHNE29RfRx{{W~Mn)HwZeR53 z{~74suQ)4?@;WN79bIYU3yi%hNhnxTu7in4w>kOLA9 z^_cPfyxl`BO^Jaqzdl`|Ez%y3HTE#{dbqX?j$5k&zQxN?z*CZw+vAZV-WEk=-9oI^ zi>;EFv9pBIbUMsM{{@)yaWwa#nUxs`jEZa5y%dJ~ZYpxpbwF;r5KM9NBrtI6bS49Z z{7GcMaXGAxDfXDD;60Li!JF~fHPwUU&ynr@B*@3ChF52>+Zzj(2PL6C2Mor0xpcaX zJz8ihH2PY@>!))WZIW^vV%K*vW$Xw?vcF2|dP9n=qCP9;7B^IZhW=jxJ&T%Ztkc=ADNzA zsx*6uOG(O5$(&<*ti|J7dW)DtZjKZ4%;`A)POZf?A4Jh3X-N5M*8W<2T>+@m+RM zso4=f_o0cfhnM$+auk~mI=kVgHZ;l-+V`UB8DLApLi~fqxxCu82ZpTHwuvkJ zMaL0c$(fK#3^%@^>W3#TVHR`5ZG3y0Clb5K47#1K#yLmQyhW_55~ZZn&H*`)Kcz#xCRQCFdlucHx%dY1wZPf=tL$KK^-_TTkBlg%SX#-AMe8 zDRJaA`0SE_!0FPPn@x{0rimZQd9k+}88MLx`S?6fu6=l1Y@h3fs<=&*q;z=urTS=C zK%}u|(8k5e&Y-zSmoYb|zD$^cY}p6(t?!f9J6m?2>Tc-Xy34Rp*Ug6P;_=3oS~ z%u;Q7%I5MiGqZ{d!-pEl{0|+1NTm+haNN1M^6$Gh!|V@!B;}D{h3pn(C{xBk%}#IR zO1TK6*^j5|!U4^zB>Fw$Ab?>qDPT1M^Jx#~^C&2cPdIB_0;KSVNk9r$##HLTSD_Z& zz)jE%*Gj)7d9uVMl=+HdJ8%e}9%lwaY;_kEvV>UsLHx;mMC@f3lzq5Iv&y8{w)@Z#?E z$bXT?tyF)?<3bugVVY6(e@Vg`2i>|)$^m~$WioLwW}oXXZ}=w;=N0{LOx0{9*as^Bb{)>T@3m+vEip|GPIJDHTEO0j?I58}) z3~@%Q(7?0uCeHM#BsO=kytmWFVcmtD#HF#V$&{e5iF)nW6D|+WjJvd;&5ukcPLykI zL)z_SO#T-IEgtk{E$oT_$8EEJI%wS_Y2C(F)`01pzGC)%N-d}qrB@+6yelt`_?uuN zPMGYZCo678{Kdb+IPo{#IN(js1Ummj@!l19H8oPMb}r|M+d{D&z2T^r|!8rbRwlE=7j zz{QM`99y%o-F!wvWl#jR$l|ML^ohwPPlBQ~Vi{{yBOjvrhl~uf zK5Vk45;70o*YhtM&7#Sc2dfA3wZq@0ZZ6N~v6zg&MzJl<$ZNrwqf-$TiT@#W`2x6Mt;TiS4huyA5^}YIPTFF^l19VciDe9QgSuo770l zz$Fvs?0FY@_UtE2YE##{%dGmgZHHfzsU_`V*H`P4*F`ul(sYs9Jq*h6rbk1>eD34Z{2K;_cLbZ46halLc ze2%NUKU&GA!WwUqG&=coFm>87tCT*F4xGxo74O@5Y3xJVE!8F_1FP%~BdC2FS9Isf zXuW-CnGh!{^D*Drcrxc3Y`W9=5ZVYqn-rEs?8_&q}IoEx+VFS zRga(VCYV$<=Zq#wk?;b+las#o#HsNw*`FGFDeA^*xQuB(cE3~CcEUYt6MjgdL|p=P z2+pPgOZ0Zk#7FPiJV}Wb={;89-U46uTu_QI1&b)P=+se1|88_^!5Um>o)Nj!lfI}_ zA{$}3*734@W4yItj?m zLJCa$`Rn$L_lRPSglt!uro*Wg-e^WHi@NW8q5zxYdq%ULx=%RZ(Ry~zKFHmgD!x8n_+?xj`!7VyZLb@!Ht zcyvx*=Ox|L<#!iwxI;b}HqA-#(_&c7eI; zh0-~Nl>BWL;lGfbd$~ThM~0`;bnAxA&t^Bg46A9F67?ijVTmmSHXl37dKJH@X%pJ( zv;J34-$9e2BLwPjbgdS-#g6)O&a!wuZ-4?=C;(W1fb*oq3F7!&Q;TDT{dSIuAJ0r( zTYW}1z5Y^?(IYRkcvPK{&UNZ!DTD2NG^^l4v6pZ*x!@0~FW+zs*VWLZvD5?b&529v zzAIr#Blpmqud6Eze&qzM(zwET6WE`YFdmz$)SiInkY`uE9 z2W8d!Z|P-BLFnbp3rcnGlI9P_{}G(V#2CJpq^&-OF7u(-e@`ex!`4!J7AZxIWjne$ z*}p)Oo)D;<^YCfczySXZ)mxzJ%Trh$e@@Xs6YI$UjQXTpMM3=OD}yJh-k2t_G}69%^Fr!Z2HQA5*4M*x@spn| zrheG^IKj0ez3X@*QK}PLKen)$lLlOFZ8tSxuEOsfZ4ZBRv~f7a=7}eY0qYvDhVUkw zZOeCWJKZrO(yrm9v!+wYKhPp+8sVTN>nKBQt1)2z7ZTr41?oJxD3UIFa*^`;bD2FhRFQI1$)e-S7>YM&OE5M83i$Yg1gC4XbSB(3HY$XeKc0w~r|t-}85eyvq znGOcAFmP`I@uNFB6D-U3R7zi&HI?4$T$XBCYp7jyF2hIU++&75Z}~Yj0lG(o!Q{%x zle@H4z=iwQ^%fFV}$@P%l|Q*S||Fc=aU(OuYN7&dFa}V3Nc7J*3pGRNHysT zpl1qYqD}+z4udN>1yr0@uF3~3%~hGND|wBbU_IaPN$MmzOSBa(DV?!lmqJAFWhao7 z6XK-N{+v`HO%=al&V4z}>Sa|@+Qf8!nk9bZMS#vdzl+RDih{^-@~-07nqb7URdH*R+DD=7!&A9Oi{-a*?F%R^?_>z|&W zHQ+4C_b)3pp#^K(qJHO8s1UDOMw^aDYOOebgZD{HMbGVDVk$+=PF2;lVmdaX96DD( z2>^x9360&?xbJ=C?ww+GUzY7mi#yf$i@Zi^^Y}?DA8FLB1O|#d@$jX3gICv(QdzlV&8dxsHV(c+LsK>QTvzU6_ zYb0#5dCxZ%c~~}R7+|_=M1NiJ;GL(M6jlh!W$wT&BZz#^;TRxOvOoC5av{aK*jUdB zEJTT7g$OLq7j%VOxq7lBmjswrMs{Cq4i_QLuY?I-R*l_PX%)WEauEF6LE{{cM%g#Z zY=g9-pHTq4-?B_^ws)ot(CdUT(Q;?3ZgB%&0-LSJk}S~oODd0f;gmE$LNlWC)*SZw zTF2tWUDe>}3GAgFzfUW{@fr-5%+TXNF!#@u3xLK#M@{^pJ@RwHxR(mQv$rbM^u)yF zp7gc4+^-scO=w4GnLoUHm&|*G%B4)zdnT-@sLAXD{t?qVWoK?M#QmO7ZDZYumcROM zT0RXq?@|A$uOb2&0IX>Ab9ty?U)lM3)bo7LPM+d~0IDZ9U)9X4Pt|IhEccrc4$Yqg zxN&t9niz^0H@V{LX*57HW5=4LcVn`mZrtz!m-E4LWa#a&|ZE=ZeR z_be>uWC0uQotqmp(+ySAn|+s`Jh^?c#?)U-^^qVEROY9akEY4F$EfL{d=!)6%BG-- zzxb^*e?e$Rf1Wl1QT?k8F>OCoXwv?=Ung`f@oR`*z|{D)G%5h9(2EXaoVg^$f5Zm< zKZTunJXG!9$1R~Oja|ej${K1yXo$j8_FcA;rjQxV!J)?|Gj8yk6(bnRAXg-|KsQuFvOvU}1Q)$#BKFf7rFv3#c^C6nuM& zOO0Gft$Kq{^uZk+fBQMx4ywF#eZ10jN%@}^6Trc3hCtkr5v?qLPeTBZoa}i>5KfE4m^W45!H&tNIy2!R)_bi2pfs)oyorVbu+nl5 ziVqIJzcjU0;LWSXA>n4vmdvWwz`nJ(vB0=#2PO^BiHo&%ecgXrM@U_;#^7aMCflK* zu?J85J`Tl@CXG@Gz9}c1FQwCP4okOwbBpS37P8a>qfV`z9k+`X5YFPzTfu%UP!6y`Fvr_P9?4V5;X6Bf8{U9#rCkAZ zM&uVB!n66B@`9(+a&}!KKRfCf^oQNN+6$^tHoMIK!>*$7-0ZFr=x>*b-P5X-LgxBY zo2Ug*pNH%q>8qqJmtk=~7g&DYcueN3PcuE3&z~%j0gUYgSS9wn57tV0QdV~{+bxEnx{U^j4&k6Tg_t{mX$_Yq$xe=@q|jc4#`MB^ zJT!tidMB9LT+XqKk3JFN=!_dS0?dknKn##1>;EeT2o)}9LyEIBz=e4SFuw9d_vq)Y znKx|vFBXdWkaNz_)-AYMGNnQ9zLj_f%C}~7N!N>u)Lf+CfEIdIU7czh$QbcAide4T zZQJy*?<2fUv(SP%PV21I_X1kz7G8vO5oI)0xCIvcYt6{A`!}bwQlGSad^&0sE+dig ztCN-J!D2iYgG*FJ2{BPzy1^u&y=FXDd67a8y7BGP|L)Sh_Z*1ci7meUFD~utdnA|k z%FkshXa7&|yHfQ-cZaL9*88w++@nx&uAPsEVL*=wVw{~gi>(snR7!xUfN3m@nIRqe z$bxi@pG5F$L=in`nIEOo82`J5h_9j*7~_4)pr(1ea&G+SOCoJiMKDK#1^!`Tmo zu(KAj$s(@Ez}~eSFWD$y#q zslU<&-b60sArh0MhfMd8Ut(rM_CQZ8FfKQivy3;fi)0|#R9eO4o~zDAw8`&mCJBRl zL+V<9>B#dX+=Ch6E=t$PUla#aJlOiq<<`$o@7t~|m@_8YX~f5JPr8|q*x0k}KKaw) zlj4s{p!Bb0(O2I@&cJP`BT4v(=^IBCC}>G;6Pl`dvTGO(u1uHZFzBch#Oi5#?{oUA zMDhff&?FU9`${$qfOt^aXNUDLXp}!L8o++(*YdqI@rZ`e_9q$WGiZtk%BdwBGNUQLOvKhbHU?bZL0ypyF6t66gl zm;}?$LvW7=cpykxJulrHg1_Tybvk9?!FUgQFW7)ZjiG5RKh5P)A-N+a_IR~*prd%Jub(3dwV#iE zEZRnitmR!zrZDwcFZbI$fi zpQ#2NyF^|ZZxhg}_2{p|uY5RbnD8K6ZJ*(Qw2)?}wekp&yaRA|Qo#DxsS?SeI+jqSMG)is9$_pX3e;QRCk`w z6Eyf}-+>ptnm-5fB$ja02cI*FiDNlWz6!au(Hs}CGqc@Mmic~|=QFFJrG1@1hjtXy z4~e%c+1cVu*QrSvt}^-J7&3CYOFA(;0v#pDtP1!!v4p;BvW*`n{US>q(dX{NUrV`ti>sUd7L3MP0-oP`aRTgYw5brGKhov{JH8&ZnR)OJ2X6Hj z*N%E-g5%w9Tu(o3p@Ox209&F)dqM|)8ypzq@>_T7)U{4lXM#FbS?FxaC!G^bZMM9+ z4tmuQbQP|}fWbv^^L6{ks3C9Ej)`TTPs7Rx%f;*+b8A$!FHS$N0rHb7YlE-;Os=Pr zQ{twGcgc=sfxFbo@AZ<0v(i)mIIN>SayZmhz4f%!>5C|cW!)L%h17s1v)z*m@qbN( zLIG`HP@`-xc!<{bo61SZlQWVZ1OuYl!Sb-gF-ru;V-o?-65R4%f%6Z;4dlCb<*tm4 zT`7ejX`!VvI;>13$7YHQz%+8p7l(Tpo$_JB4f^W={o?Bv;zK3iLCjqj{gvE5lo;fd zHH{q|VzJ(ecLFb~dW44K((lhkhDQ$2inQ@ZcRq7Y>-^*1b>gOVEt)4}ovdHpbt^K@ z|3sf`Dm|bJwcZkK{pP34+PPS-&Y(HzYpQh%%*U0(ohJ^qYv&SPhZse79v3M#nTUb? zTTjUjU*9&)0S1{kUx6pKuPYG_c~z}evFZy5xUz{>?k8wd2OGRLnS6!W@2E;KWyJGkUt&UFTh*2NVjj=kW%jj~V001z!4 z=ACav4hf=_2vC25z)FK{a-HCIF%1b@(>NH^N7$**yWUBYO61yA32R`g-kGrQqT2&s zZ1aW~`>zx~03Uhl@0bL?Vul+mpc)cp64nzfU1rpi*eG&?8WU7Xl4Pf1!!_iKpK_${ zC;xLY0h})InNl8x8hkL6Jpz7odsa%}^mCw|17HWPhf{dC+kQ}x((i~n?<}jL=p9a@ z<9^KPtHyuVYuBL`*B7H;P2iVO8ICwx_P&$c40y;=GC7R)u@F`J-|`;#me&bZ9#xFU zJg^Th!=rFfc{Bw+ujIxWBM>U0T(6i0?6X&W^QWn?a#<*foA?<)RQJ+am_wkw5~pN- z7sfTpB>PChT4dEn1d;2VMl0o-hg^bZeAQZSZ%fT*?fK_jkzO;p1^Kn_+yjstFP#ra zNvx;BrMYSMj?`B;0sS zFuJaW4L~Ou?IWxSIxyrDP0$laaSx}5DtUOzHO?=y^m2JYfcOG)&~ws}entE=bCT7$ z=#rYt?lU1eR^i}WaqU8Z0rKPflqR^`l!q|k(Zo+khOK+ubx;hXEPh&3dhXVaKhK_5 zEWuW;iN*%L+&b5&xM}Dl-pY8w8~S%KsSYAxoEeE0RatjS6)vupzw^Mi4zR4J9^a9vEO zGsL1|=&T;B!-Hc|XANCOT4+&_Am}oQeN;)!5I#Ng%dGfD89Z`xzBJfQ5Uq?0g3AeUS9@IhE|>w~}OV)8>HvkoV#COPN{LT#vk8 zt2Z)j@{a(~lW*kv*4-rOL6sffa^(OAYdJ-0AsgF9gwSQe2wH&X@4yh*TSHt#%TNt1(?*1p$1*$&WoXj%(3D- zcQ5QJ#PkYUg9UjMs?vZCI$TX&{X=JmqECeM2>uCx|CpLx$`!gYuDe(vVX}YRkFG^k zURe>tw{_d=^mg9nvS?KtpkI=2?(iG$tPXR5QosdvzxGoCt z$$I=Gfzpq+2F3?10L^~%hk|tHo!byiu28i+0-PzrVDKCekd-_eW}(>Fp}Ancc191J z%LV{ozGVXd7!U|yD)X?cRj`u12B#u~Q22#>5x;tCwV54R+A8Kzk+(poe&f<5a*v*K zT2oU&Cy_LPGej(sedjw!v3{YylrY}sxYF)>cfp<-T!xEu)CFu&YJe?D)I%N!%*L!8 zEi#ZVi4r-oMksMF`zOoUUiq(+KVL}Vgk4zs|M2{i%LBzJSShuf5=6EJK+gfbJ})q= zG0GhyJ>s|)s`}>jgj5{06DiB8;CT5#UeEFuCDRNU65yFEh+SOUYPR?{idoz^hcctc z&442k_wYk5d(L7ZTKmy)4^n0o##7c6!_jl_B86&KbNSP0;&tq_AS1DeI66n%PR*pX zi2%0k-ZNP@3`AaRb)vJ?W}XEv*Z1a+PPd6tY;c0IY-s0=Iw-*C*soU) zC=bBofdMQRHt;f`m;%bDO+Q@6&hS8dvdDDe(V_H-k2t&!J`FL&9w2#0bHLqd5+>n8)4e;ua%TPUO&4#d!TjvD`IHe+m+wqABkj zoNs5r+GI!s>cQZx77EF%7%V;lk~d43R$%h9**@|sc6SSR>J07Anld(@sT0nyR>Qu_ zPhkc@Fj;M*AKsf3%f|p*H1HyY%3g7T%cCKt?y8k0=-`j0laL`{!mVH11jZ{=3)Zbo z21^05#asw*jiv?Hew&@KV*;teNz-jz?UZ2y0k!l8DBW^9Rj~0!uD>Ft|27Lg;_|N} z*?vvL_xnuig>$EG@^@kLoJ?zdbt0stXU1YVLJO_W zCv!h-*}a>}{Q3SZv`DX6-2%p&B;T>R%A72KsxXP5VK54m2trhI`mBmx(#zV{ zInu6zS{==2l?XBO^i7UsOK?Fk{?ekyEXECjxn| ze`kRpJim|8Q}?3d(XG1>vcoX%zs<(_g-QWYTElLe@&5AL%%^F!{2#PFiop zRz~d(ix56>b@e=g)qGNk>2`{de6Q_WxRCIF*6yQFR#bxy#Qy{EQ~~2n-V>tkL{`UY z&0Rmmuj2DpeT)jObl<7A@des_b`d1V25nwoq~e9M<^f>hHSU>co8g(*{m}-YwofiI z-mkS=3Wl~O+8MFVW{YqX8E6K**_pPc`QNK@m~X8Hg&Kle5qX4L!dd6!IWdLU*Nlkc zGiH(n$H6or(h^BfuCPB&?kP`30z;2(u1 zR+FQfD9dIbldYlRvSLo87bRrF5U656yei7F$Z+uFv&!-!9(3wD{QY)By0oUJmuQ{- zU}FV=;Y7LSZ1uxnRdzVY10dxWlIkcKoJet_HxrwC@n~W6^hFyQekJ5|pV<4XQj zka1?kZLfD%g`ld(`_Jln6>AAWt9jnwML-$NI@O($<9KJ{W`C%l?Zl4-L0J7Mr!-?21u}Dy5k;D zu}!eeZ*3?R;L}9xDghYu?{zNJxF-U5o>7it>+~T~$v2ua{;7P)^J*yJ6~TT02(a@l_L<@JIZo3wOYJ9t9BNNUnvpIZ184_1fah;Vh@r1saB z^4y@`7jq3dxmVlsiow+%)C~5)FovY6v>3pvw$J%t@r@7cp&Ec@j$@T1u-i81-!`X5 z*u0~!^hDZq+7k7};*;b~0?h1x(q(|(>8OIVD1hr(THoGWk=iwDyIPzQf69sA=(J+o zn#EcLV}QPlry2xM(Oe*&QuTxz|DO({_ui&T9ig&XSsUK?V&dy)5>MGnr6uw&*J)SR z4O5d0C2t!+(VG{Y3fFU3G4!F~;z`0^Zy$VT zlJGjGSF&$3BUtfc03n5Fp1KQfb~InA&8`q*1q&GG=||Hzpy6L2H1f*;LpyQht{w?} zDZ2kUk>FaSr)>&iD|Z|7sH6U!z%}z@JhB~OedrN<`}Lfq^UV}Y43>cn?*zZ0AOM2< zpX5w(`QSQaEYTvqHz~=NXHUjQf0o%dBkQfeAN31lR&xxOEgYHTdZp%bVXN280=Ana z^M=FH$n=5rl?&BI)^08Qe_`>YwGkkoEIR+Kv^%~Pb0k^b?3|sA#qp8cs#eTueeM2Q zRw=0&M&6mX$~YF!Y0ZBc@63#c7`f!9BKSXd@Voc{RoLU+XN*d^;RK${8T?=LBS%Bk z&gkb&o-U3d6^w6h1+IPUz|;DW zIZ;96kdsD>Qv^q=09&hp0GpEni<1IR%gvP3v%OR9*{MuRTKWHZyIbuBt)Ci`cU_&% z1T+i^Y)o{%281-<3TpPAUTzw5v;RY=>1rvxmPl96#kYc9hX!6V^nB|ad#(S+)}?8C zr_H+lT3B#So$T=?$(w3-{rbQ4R<@nsf$}$hwSO)A$8&`(j+wQf=Jwhb0`CvhR5DCf z^OgI)KQemrUFPH+UynC$Y~QHG%DbTVh-Skz{enNU)cV_hPu~{TD7TPZl>0&K>iuE| z7AYn$7)Jrb9GE&SfQW4q&G*@N|4cHI`VakFa5-C!ov&XD)J(qp$rJJ*9e z-sHv}#g*T7Cv048d1v~BEAzM5FztAse#q78WWC^BUCzQ U&wLp6h6BX&boFyt=akR{0G%$)mH+?% literal 0 HcmV?d00001 diff --git a/docs/api/1.21.0/assets/images/widgets@2x.png b/docs/api/1.21.0/assets/images/widgets@2x.png new file mode 100644 index 0000000000000000000000000000000000000000..4bbbd57272f3b28f47527d4951ad10f950b8ad43 GIT binary patch literal 855 zcmeAS@N?(olHy`uVBq!ia0y~yU}^xe12~w0Jcmn z@(X6T|9^jgLcx21{)7exgY)a>N6m2F0<`Rqr;B4q1>>88jUdw-7W`c)zLE*mq8W2H z-<&Jl_Hco5BuC5n@AbF5GD82~-e8-v=#zCyUX0F-o}8pPfAv`!GN$ff+TL<~@kgt} z62eO?_|&+>xBmM$@p|z`tIKEdpPf8%qI>4r7@jn<=eta*{3~?g(zz{Ke9zc-G^gr? z-7foa?LcS!hmbwzru}ICvbWLlW8;+l-}!^=c32!^nV`+`C*;0-*Y%l94pC;Cb3GXz zzSf%a!{gVr{Y_lVuUj+a)*Ca+!-Hu%xmP&&X-2CuANY8^i{D7Kg6qzP zXz_ps9+lN8ESH{K4`yu&b~I>N9xGlE&;2u*b?+Go!AhN?m-bxlLvtC#MzDF2kFzfHJ1W7ybqdefSqVhbOykd*Yi%EDuhs z4wF{ft^bv2+DDnKb8gj1FuvcV`M}luS>lO<^)8x>y1#R;a=-ZKwWTQQb)ioBbi;zh zD!f5V)8581to1LL7c9!l^PSC$NBPYif!_vAZhmL4)v4U)4UsrLYiH_9rmQDd?)(e5 z^pcH>qvBg*i0dus2r*mp4;zKvu=P#s-ti;2obl`NjjwoYd>e(oo#j_uyRb<7Pv^If zzZ|mGHmV)8^tbO%^>eqMw(@7(&3g{jEp-Najo7V75xI_ZHK*FA`elF{r5}E*d7+j_R literal 0 HcmV?d00001 diff --git a/docs/api/1.21.0/assets/js/main.js b/docs/api/1.21.0/assets/js/main.js new file mode 100644 index 0000000000..fe9fac3b3b --- /dev/null +++ b/docs/api/1.21.0/assets/js/main.js @@ -0,0 +1 @@ +!function(){var e=function(t){var r=new e.Builder;return r.pipeline.add(e.trimmer,e.stopWordFilter,e.stemmer),r.searchPipeline.add(e.stemmer),t.call(r,r),r.build()};e.version="2.3.7",e.utils={},e.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),e.utils.asString=function(e){return null==e?"":e.toString()},e.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),r=Object.keys(e),i=0;i=this.length)return e.QueryLexer.EOS;var t=this.str.charAt(this.pos);return this.pos+=1,t},e.QueryLexer.prototype.width=function(){return this.pos-this.start},e.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},e.QueryLexer.prototype.backup=function(){this.pos-=1},e.QueryLexer.prototype.acceptDigitRun=function(){for(var t,r;47<(r=(t=this.next()).charCodeAt(0))&&r<58;);t!=e.QueryLexer.EOS&&this.backup()},e.QueryLexer.prototype.more=function(){return this.pos=this.scrollTop||0===this.scrollTop,isShown!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),this.secondaryNav.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop},Viewport}(typedoc.EventTarget);typedoc.Viewport=Viewport,typedoc.registerService(Viewport,"viewport")}(typedoc||(typedoc={})),function(typedoc){function Component(options){this.el=options.el}typedoc.Component=Component}(typedoc||(typedoc={})),function(typedoc){typedoc.pointerDown="mousedown",typedoc.pointerMove="mousemove",typedoc.pointerUp="mouseup",typedoc.pointerDownPosition={x:0,y:0},typedoc.preventNextClick=!1,typedoc.isPointerDown=!1,typedoc.isPointerTouch=!1,typedoc.hasPointerMoved=!1,typedoc.isMobile=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent),document.documentElement.classList.add(typedoc.isMobile?"is-mobile":"not-mobile"),typedoc.isMobile&&"ontouchstart"in document.documentElement&&(typedoc.isPointerTouch=!0,typedoc.pointerDown="touchstart",typedoc.pointerMove="touchmove",typedoc.pointerUp="touchend"),document.addEventListener(typedoc.pointerDown,function(e){typedoc.isPointerDown=!0,typedoc.hasPointerMoved=!1;var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e;typedoc.pointerDownPosition.y=t.pageY||0,typedoc.pointerDownPosition.x=t.pageX||0}),document.addEventListener(typedoc.pointerMove,function(e){if(typedoc.isPointerDown&&!typedoc.hasPointerMoved){var t="touchstart"==typedoc.pointerDown?e.targetTouches[0]:e,x=typedoc.pointerDownPosition.x-(t.pageX||0),y=typedoc.pointerDownPosition.y-(t.pageY||0);typedoc.hasPointerMoved=10scrollTop;)index-=1;for(;index"+match+""}),parent=row.parent||"";(parent=parent.replace(new RegExp(this.query,"i"),function(match){return""+match+""}))&&(name=''+parent+"."+name);var item=document.createElement("li");item.classList.value=row.classes,item.innerHTML='\n '+name+"'\n ",this.results.appendChild(item)}}},Search.prototype.setLoadingState=function(value){this.loadingState!=value&&(this.el.classList.remove(SearchLoadingState[this.loadingState].toLowerCase()),this.loadingState=value,this.el.classList.add(SearchLoadingState[this.loadingState].toLowerCase()),this.updateResults())},Search.prototype.setHasFocus=function(value){this.hasFocus!=value&&(this.hasFocus=value,this.el.classList.toggle("has-focus"),value?(this.setQuery(""),this.field.value=""):this.field.value=this.query)},Search.prototype.setQuery=function(value){this.query=value.trim(),this.updateResults()},Search.prototype.setCurrentResult=function(dir){var current=this.results.querySelector(".current");if(current){var rel=1==dir?current.nextElementSibling:current.previousElementSibling;rel&&(current.classList.remove("current"),rel.classList.add("current"))}else(current=this.results.querySelector(1==dir?"li:first-child":"li:last-child"))&¤t.classList.add("current")},Search.prototype.gotoCurrentResult=function(){var current=this.results.querySelector(".current");if(current||(current=this.results.querySelector("li:first-child")),current){var link=current.querySelector("a");link&&(window.location.href=link.href),this.field.blur()}},Search.prototype.bindEvents=function(){var _this=this;this.results.addEventListener("mousedown",function(){_this.resultClicked=!0}),this.results.addEventListener("mouseup",function(){_this.resultClicked=!1,_this.setHasFocus(!1)}),this.field.addEventListener("focusin",function(){_this.setHasFocus(!0),_this.loadIndex()}),this.field.addEventListener("focusout",function(){_this.resultClicked?_this.resultClicked=!1:setTimeout(function(){return _this.setHasFocus(!1)},100)}),this.field.addEventListener("input",function(){_this.setQuery(_this.field.value)}),this.field.addEventListener("keydown",function(e){13==e.keyCode||27==e.keyCode||38==e.keyCode||40==e.keyCode?(_this.preventPress=!0,e.preventDefault(),13==e.keyCode?_this.gotoCurrentResult():27==e.keyCode?_this.field.blur():38==e.keyCode?_this.setCurrentResult(-1):40==e.keyCode&&_this.setCurrentResult(1)):_this.preventPress=!1}),this.field.addEventListener("keypress",function(e){_this.preventPress&&e.preventDefault()}),document.body.addEventListener("keydown",function(e){e.altKey||e.ctrlKey||e.metaKey||!_this.hasFocus&&47this.groups.length-1&&(index=this.groups.length-1),this.index!=index){var to=this.groups[index];if(-1 + + + + + Cache | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Cache<T>

+
+
+
+
+
+
+
+
+
+

Representation of a cache to transiently store objects locally for faster access.

+
+
+
+
+

Type parameters

+
    +
  • +

    T

    +
    +
    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + Cache +
    • +
+
+
+

Implements

+
    +
  • CacheInterface<T>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new Cache(validityTime?: MomentInputObject): Cache
    • +
+ +
+
+
+

Methods

+
+ +

clear

+
    +
  • clear(): void
    • +
+ +
+
+ +

get

+
    +
  • get(key: string): T | undefined
    • +
+
    +
  • + +
    +
    +

    Getter of cached entries.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      The key of the entry to retrieve

      +
      +
      • +
    +

    Returns T | undefined

    +

    The corresponding entry to the provided key if it is still valid, returns undefined otherwise

    +
    • +
+
+
+ +

hasKey

+
    +
  • hasKey(key: string): boolean
    • +
+
    +
  • + +
    +
    +

    Specifies whether an entry with a given key is defined in cache.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      The entry's key

      +
      +
      • +
    +

    Returns boolean

    +

    boolean A boolean value that indicates whether the entry exists in cache

    +
    • +
+
+
+ +

set

+
    +
  • set(key: string, entry: T, expirationTime?: undefined | number): void
    • +
+
    +
  • + +
    +
    +

    Setter of entries in cache.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      The entry's key

      +
      +
      • +
    • +
      entry: T
      +
      +

      The entry to cache

      +
      +
      • +
    • +
      Optional expirationTime: undefined | number
      +
      +

      The time expressed in UTC in which the given entry expires

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.createrequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.createrequestbuilder-1.html new file mode 100644 index 0000000000..39c1803c3e --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.createrequestbuilder-1.html @@ -0,0 +1,694 @@ + + + + + + CreateRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CreateRequestBuilder<EntityT>

+
+
+
+
+
+
+
+
+
+

Create OData request to create an entity.

+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: Entity

    +
    +
    +

    Type of the entity to be created

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataCreateRequestConfig<EntityT>> +
      +
    • + CreateRequestBuilder +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • EntityIdentifiable<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new CreateRequestBuilder(_entityConstructor: Constructable<EntityT>, _entity: EntityT): CreateRequestBuilder
    • +
+ +
+
+
+

Properties

+
+ +

Readonly _entity

+
_entity: EntityT
+ +
+
+

Entity to be created

+
+
+
+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to be created

+
+
+
+
+ +

requestConfig

+
requestConfig: ODataCreateRequestConfig<EntityT>
+ +
+
+

Request configuration to initialize with

+
+
+
+
+
+

Accessors

+
+ +

entity

+
    +
  • get entity(): EntityT
    • +
+ +
+
+
+

Methods

+
+ +

asChildOf

+
    +
  • asChildOf<ParentEntityT>(parentEntity: ParentEntityT, linkField: Link<ParentEntityT, EntityT>): this
    • +
+
    +
  • + +
    +
    +

    Specifies the parent of the entity to create.

    +
    +
    +

    Type parameters

    +
      +
    • +

      ParentEntityT: Entity

      +
      • +
    +

    Parameters

    +
      +
    • +
      parentEntity: ParentEntityT
      +
      +

      Parent of the entity to create

      +
      +
      • +
    • +
      linkField: Link<ParentEntityT, EntityT>
      +
      +

      Static representation of the navigation property that navigates from the parent entity to the child entity

      +
      +
      • +
    +

    Returns this

    +

    The entity itself, to facilitate method chaining

    +
    • +
+
+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

prepare

+
    +
  • prepare(): this
    • +
+ +
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.customfield-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.customfield-1.html new file mode 100644 index 0000000000..17d2a719f6 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.customfield-1.html @@ -0,0 +1,641 @@ + + + + + + CustomField | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class CustomField<EntityT>

+
+
+
+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+
    +
  • + CustomFieldBase<EntityT> +
      +
    • + CustomField +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • EntityIdentifiable<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new CustomField(_fieldName: string, _entityConstructor: Constructable<EntityT>): CustomField
    • +
+ +
+
+
+

Properties

+
+ +

Readonly _entity

+
_entity: EntityT
+ +
+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+ +

Readonly _fieldName

+
_fieldName: string
+ +
+
+
+

Methods

+
+ +

edmBinary

+
    +
  • edmBinary(): StringField<EntityT>
    • +
+ +
+
+ +

edmBoolean

+
    +
  • edmBoolean(): BooleanField<EntityT>
    • +
+ +
+
+ +

edmByte

+
    +
  • edmByte(): NumberField<EntityT>
    • +
+ +
+
+ +

edmDateTime

+
    +
  • edmDateTime(): DateField<EntityT>
    • +
+ +
+
+ +

edmDateTimeOffset

+
    +
  • edmDateTimeOffset(): DateField<EntityT>
    • +
+ +
+
+ +

edmDecimal

+
    +
  • edmDecimal(): BigNumberField<EntityT>
    • +
+ +
+
+ +

edmDouble

+
    +
  • edmDouble(): NumberField<EntityT>
    • +
+ +
+
+ +

edmGuid

+
    +
  • edmGuid(): StringField<EntityT>
    • +
+ +
+
+ +

edmInt16

+
    +
  • edmInt16(): NumberField<EntityT>
    • +
+ +
+
+ +

edmInt32

+
    +
  • edmInt32(): NumberField<EntityT>
    • +
+ +
+
+ +

edmInt64

+
    +
  • edmInt64(): BigNumberField<EntityT>
    • +
+ +
+
+ +

edmSByte

+
    +
  • edmSByte(): NumberField<EntityT>
    • +
+ +
+
+ +

edmSingle

+
    +
  • edmSingle(): NumberField<EntityT>
    • +
+ +
+
+ +

edmString

+
    +
  • edmString(): StringField<EntityT>
    • +
+ +
+
+ +

edmTime

+
    +
  • edmTime(): TimeField<EntityT>
    • +
+ +
+
+ +

fieldPath

+
    +
  • fieldPath(): string
    • +
+
    +
  • + +
    +
    +

    Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.

    +
    +
    +

    Returns string

    +

    Path to the field to be used in filter and order by queries.

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Method
    • +
+
    +
  • Inherited constructor
    • +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.deleterequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.deleterequestbuilder-1.html new file mode 100644 index 0000000000..e35e3675bb --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.deleterequestbuilder-1.html @@ -0,0 +1,643 @@ + + + + + + DeleteRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class DeleteRequestBuilder<EntityT>

+
+
+
+
+
+
+
+
+
+

Create OData query to delete an entity.

+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: Entity

    +
    +
    +

    Type of the entity to be deleted

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataDeleteRequestConfig<EntityT>> +
      +
    • + DeleteRequestBuilder +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • EntityIdentifiable<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ +
    +
  • + +
    +
    +

    Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.

    +
    +
    +

    Parameters

    +
      +
    • +
      entityConstructor: Constructable<EntityT>
      +
      +
      +

      Constructor type of the entity to be deleted

      +
      +
      +
      • +
    • +
      keysOrEntity: MapType<FieldType> | Entity
      +
      +
      +

      Entity or Key-value pairs of key properties for the given entity

      +
      +
      +
      • +
    +

    Returns DeleteRequestBuilder

    +
    • +
+
+
+
+

Properties

+
+ +

Readonly _entity

+
_entity: EntityT
+ +
+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+ +

requestConfig

+
requestConfig: ODataDeleteRequestConfig<EntityT>
+ +
+
+

Request configuration to initialize with

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

ignoreVersionIdentifier

+
    +
  • ignoreVersionIdentifier(): this
    • +
+
    +
  • + +
    +
    +

    Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

    +
    +
    +

    Returns this

    +

    this The request itself to ease chaining while executing the request

    +
    • +
+
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

setVersionIdentifier

+
    +
  • setVersionIdentifier(etag: string): this
    • +
+ +
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.entity-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.entity-1.html new file mode 100644 index 0000000000..efeebb037f --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.entity-1.html @@ -0,0 +1,848 @@ + + + + + + Entity | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class Entity

+
+
+
+
+
+
+
+
+
+

Super class for all representations of OData entity types.

+
+
+
+
+

Hierarchy

+
    +
  • + EntityBase +
      +
    • + Entity +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Protected _customFields

+
_customFields: MapType<any>
+ +
+
+

A mapper representing custom fields in an entity. + Custom fields are represented by their field names and the corresponding values. + A custom field can be added or updated using setCustomField method.

+
+
+
+
+ +

Readonly _oDataVersion

+
_oDataVersion: "v2" = "v2"
+ +
+
+ +

Protected _versionIdentifier

+
_versionIdentifier: string
+ +
+
+

The current ETag version of the entity in the remote system. + The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. + When no ETag is provided by the remote system the value of this variable defaults to "*".

+
+
+
+
+ +

Protected remoteState

+
remoteState: {}
+ +
+
+

The remote state of the entity. + Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. + It is stored as map, where the keys are stored in the format of the original OData properties.

+
+
+
+

Type declaration

+
    +
  • +
    [keys: string]: any
    +
    • +
+
+
+
+ +

Static _defaultServicePath

+
_defaultServicePath: string
+ +
+
+ +

Static _entityName

+
_entityName: string
+ +
+
+ +

Static _serviceName

+
_serviceName: string
+ +
+
+
+

Accessors

+
+ +

versionIdentifier

+
    +
  • get versionIdentifier(): string
    • +
+ +
+
+
+

Methods

+
+ +

Protected getCurrentMapKeys

+
    +
  • getCurrentMapKeys(): this
    • +
+ +
+
+ +

getCustomField

+
    +
  • getCustomField(fieldName: string): any
    • +
+
    +
  • + +
    +
    +

    Custom field value getter.

    +
    +
    +

    Parameters

    +
      +
    • +
      fieldName: string
      +
      +

      The name of the custom field

      +
      +
      • +
    +

    Returns any

    +

    The value of the corresponding custom field

    +
    • +
+
+
+ +

getCustomFields

+
    +
  • getCustomFields(): MapType<any>
    • +
+ +
+
+ +

getUpdatedCustomFields

+
    +
  • getUpdatedCustomFields(): MapType<any>
    • +
+ +
+
+ +

getUpdatedProperties

+
    +
  • getUpdatedProperties(): this
    • +
+ +
+
+ +

hasCustomField

+
    +
  • hasCustomField(fieldName: string): boolean
    • +
+
    +
  • + +
    +
    +

    Validates whether a custom field exists in the entity.

    +
    +
    +

    Parameters

    +
      +
    • +
      fieldName: string
      +
      +

      The name of the custom field to update

      +
      +
      • +
    +

    Returns boolean

    +

    A boolean value, that indicates whether a custom field is defined in entity

    +
    • +
+
+
+ +

initializeCustomFields

+
    +
  • initializeCustomFields(customFields: MapType<any>): this
    • +
+
    +
  • + +
    +
    +

    Sets all retrieved custom fields in entity.

    +
    +
    +

    Parameters

    +
      +
    • +
      customFields: MapType<any>
      +
      +

      Extracted custom fields from a retrieved entity

      +
      +
      • +
    +

    Returns this

    +

    A boolean value, that indicates the existence of the field in entity

    +
    • +
+
+
+ +

Protected isConflictingCustomField

+
    +
  • isConflictingCustomField(customFieldName: string): boolean
    • +
+
    +
  • + +
    +
    +

    Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    +
    +
    +

    Parameters

    +
      +
    • +
      customFieldName: string
      +
      +

      Field name to check

      +
      +
      • +
    +

    Returns boolean

    +

    Boolean value that describes whether a field name can be defined as custom field

    +
    • +
+
+
+ +

setCustomField

+
    +
  • setCustomField(fieldName: string, value: any): this
    • +
+
    +
  • + +
    +
    +

    Sets a new custom field in the entity or updates it. + Throws an error, if the provided custom field name is already defined by an original field in entity.

    +
    +
    +

    Parameters

    +
      +
    • +
      fieldName: string
      +
      +

      The name of the custom field to update

      +
      +
      • +
    • +
      value: any
      +
      +

      The value of the field

      +
      +
      • +
    +

    Returns this

    +

    The entity itself, to facilitate method chaining

    +
    • +
+
+
+ +

setOrInitializeRemoteState

+
    +
  • setOrInitializeRemoteState(state?: MapType<any>): this
    • +
+
    +
  • + +
    +
    +

    Initializes or sets the remoteState of the entity. + This function is called on all read, create and update requests. + This function should be called after initializeCustomFields, if custom fields are defined.

    +
    +
    +
    deprecated
    +

    Since 1.12.0. Will be removed in version 2.0.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      Optional state: MapType<any>
      +
      +

      State to be set as remote state

      +
      +
      • +
    +

    Returns this

    +

    The entity itself, to facilitate method chaining

    +
    • +
+
+
+ +

setVersionIdentifier

+
    +
  • setVersionIdentifier(etag: string | undefined): this
    • +
+
    +
  • + +
    +
    +

    Set the ETag version identifier of the retrieved entity.

    +
    +
    +

    Parameters

    +
      +
    • +
      etag: string | undefined
      +
      +

      The returned ETag version of the entity

      +
      +
      • +
    +

    Returns this

    +

    The entity itself, to facilitate method chaining

    +
    • +
+
+
+ +

Static Protected customFieldSelector

+
    +
  • customFieldSelector<EntityT>(fieldName: string, entityConstructor: Constructable<EntityT>): CustomField<EntityT>
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      EntityT: EntityBase

      +
      • +
    +

    Parameters

    +
      +
    • +
      fieldName: string
      +
      • +
    • +
      entityConstructor: Constructable<EntityT>
      +
      • +
    +

    Returns CustomField<EntityT>

    +
    • +
+
+
+ +

Static Protected entityBuilder

+
    +
  • entityBuilder<EntityT, EntityTypeForceMandatoryT>(entityConstructor: Constructable<EntityT, EntityTypeForceMandatoryT>): EntityBuilderType<EntityT, EntityTypeForceMandatoryT>
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Property
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited constructor
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.functionimportrequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.functionimportrequestbuilder-1.html new file mode 100644 index 0000000000..eceaae212d --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.functionimportrequestbuilder-1.html @@ -0,0 +1,636 @@ + + + + + + FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class FunctionImportRequestBuilder<ParametersT, ReturnT>

+
+
+
+
+
+
+
+
+
+

Create OData request to execute a function import.

+
+
+
+
+

Type parameters

+
    +
  • +

    ParametersT

    +
    +
    +

    Type of the function import parameters

    +
    +
    +
    • +
  • +

    ReturnT

    +
    +
    +

    Type of the function import return value

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataFunctionImportRequestConfig<ParametersT>> +
      +
    • + FunctionImportRequestBuilder +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ +
    +
  • + +
    +
    +

    Creates an instance of FunctionImportRequestBuilder.

    +
    +
    +

    Parameters

    +
      +
    • +
      method: RequestMethodType
      +
      +
      +

      HTTP method to be used for the request

      +
      +
      +
      • +
    • +
      defaultServicePath: string
      +
      +
      +

      Default path for the service the function belongs to

      +
      +
      +
      • +
    • +
      functionImportName: string
      +
      +
      +

      The name of the function import.

      +
      +
      +
      • +
    • +
      responseTransformer: (data: any) => ReturnT
      +
      +
      +

      Transformation function for the response

      +
      +
      +
        +
      • +
          +
        • (data: any): ReturnT
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: any
            +
            • +
          +

          Returns ReturnT

          +
          • +
        +
        • +
      +
      • +
    • +
      parameters: FunctionImportParameters<ParametersT>
      +
      +
      +

      Parameters to be set in the function

      +
      +
      +
      • +
    +

    Returns FunctionImportRequestBuilder

    +
    • +
+
+
+
+

Properties

+
+ +

requestConfig

+
requestConfig: ODataFunctionImportRequestConfig<ParametersT>
+ +
+
+

Request configuration to initialize with

+
+
+
+
+ +

Readonly responseTransformer

+
responseTransformer: (data: any) => ReturnT
+ +
+
+

Transformation function for the response

+
+
+
+

Type declaration

+
    +
  • +
      +
    • (data: any): ReturnT
      • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        data: any
        +
        • +
      +

      Returns ReturnT

      +
      • +
    +
    • +
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.getallrequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.getallrequestbuilder-1.html new file mode 100644 index 0000000000..548f86c2f6 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.getallrequestbuilder-1.html @@ -0,0 +1,761 @@ + + + + + + GetAllRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GetAllRequestBuilder<EntityT>

+
+
+
+
+
+
+
+
+
+

Create OData request to get multiple entities based on the configuration of the request. A GetAllRequestBuilder allows to restrict the response in multiple dimensions. + The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields. + The entities can be filtered and ordered based on the values of their properties. + The number of entities in the result can be limited and results can be skipped for paging purposes. + If none of the above mentioned are configured all entities of the given type will be requested.

+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: Entity

    +
    +
    +

    Type of the entity to be requested

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataGetAllRequestConfig<EntityT>> +
      +
    • + GetAllRequestBuilder +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • EntityIdentifiable<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly _entity

+
_entity: EntityT
+ +
+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor of the entity to create the request for

+
+
+
+
+ +

requestConfig

+
requestConfig: ODataGetAllRequestConfig<EntityT>
+ +
+
+

Request configuration to initialize with

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

filter

+
    +
  • filter(...expressions: Filterable<EntityT>[]): this
    • +
+ +
+
+ +

orderBy

+
    +
  • orderBy(...orderBy: Orderable<EntityT>[]): this
    • +
+ +
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

select

+
    +
  • select(...selects: Selectable<EntityT>[]): this
    • +
+ +
+
+ +

skip

+
    +
  • skip(skip: number): this
    • +
+ +
+
+ +

top

+
    +
  • top(top: number): this
    • +
+
    +
  • + +
    +
    +

    Limit number of returned entities.

    +
    +
    +

    Parameters

    +
      +
    • +
      top: number
      +
      +

      Maximum number of entities to return in the response. Can be less, if less entities match the request

      +
      +
      • +
    +

    Returns this

    +

    The request builder itself, to facilitate method chaining

    +
    • +
+
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.getbykeyrequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.getbykeyrequestbuilder-1.html new file mode 100644 index 0000000000..fde0e18fd7 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.getbykeyrequestbuilder-1.html @@ -0,0 +1,622 @@ + + + + + + GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GetByKeyRequestBuilder<EntityT>

+
+
+
+
+
+
+
+
+
+

Create OData request to get a single entity based on its key properties. A GetByKeyRequestBuilder allows to restrict the response to a selection of fields, + where no selection is equal to selecting all fields.

+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: Entity

    +
    +
    +

    Type of the entity to be requested

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataGetByKeyRequestConfig<EntityT>> +
      +
    • + GetByKeyRequestBuilder +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • EntityIdentifiable<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ +
    +
  • + +
    +
    +

    Creates an instance of GetByKeyRequestBuilder.

    +
    +
    +

    Parameters

    +
      +
    • +
      _entityConstructor: Constructable<EntityT>
      +
      +
      +

      Constructor of the entity to create the request for

      +
      +
      +
      • +
    • +
      keys: MapType<FieldType>
      +
      +
      +

      Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value

      +
      +
      +
      • +
    +

    Returns GetByKeyRequestBuilder

    +
    • +
+
+
+
+

Properties

+
+ +

Readonly _entity

+
_entity: EntityT
+ +
+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor of the entity to create the request for

+
+
+
+
+ +

requestConfig

+
requestConfig: ODataGetByKeyRequestConfig<EntityT>
+ +
+
+

Request configuration to initialize with

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

select

+
    +
  • select(...selects: Selectable<EntityT>[]): this
    • +
+ +
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchchangeset-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchchangeset-1.html new file mode 100644 index 0000000000..3e111f83c1 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchchangeset-1.html @@ -0,0 +1,247 @@ + + + + + + ODataBatchChangeSet | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataBatchChangeSet<T>

+
+
+
+
+
+
+
+
+
+

OData batch change set, which holds a collection of write operations.

+
+
+
+
+

Type parameters

+ +
+
+

Hierarchy

+
    +
  • + ODataBatchChangeSet +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly changeSetId

+
changeSetId: string
+ +
+
+ +

Readonly requests

+
requests: T[]
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchconfig.html new file mode 100644 index 0000000000..a9ce6aadc9 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchconfig.html @@ -0,0 +1,596 @@ + + + + + + ODataBatchConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataBatchConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ODataBatchRequestConfig +
      +
    • + ODataBatchConfig +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new ODataBatchConfig(defaultServicePath: string, batchId: string): ODataBatchConfig
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.21.0. Use superclass instead. + Creates an instance of ODataBatchConfig.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      defaultServicePath: string
      +
      +
      +

      The default OData service path

      +
      +
      +
      • +
    • +
      batchId: string
      +
      +
      +

      The batch id for building the header and the payload.

      +
      +
      +
      • +
    +

    Returns ODataBatchConfig

    +
    • +
+
+
+
+

Properties

+
+ +

Readonly batchId

+
batchId: string
+ +
+
+

The batch id for building the header and the payload.

+
+
+
+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

The default OData service path

+
+
+
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+ +

Static Readonly content_type_prefix

+
content_type_prefix: "multipart/mixed; boundary=batch_" = "multipart/mixed; boundary=batch_"
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchrequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchrequestbuilder-1.html new file mode 100644 index 0000000000..3d06f659af --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatabatchrequestbuilder-1.html @@ -0,0 +1,598 @@ + + + + + + ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataBatchRequestBuilder

+
+
+
+
+
+
+
+
+
+

The OData batch request builder to build a batch, which consists of an ordered retrieve requests or change sets.

+
+
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataBatchRequestConfig> +
      +
    • + ODataBatchRequestBuilder +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

Service path

+
+
+
+
+ +

Readonly entityToConstructorMap

+
entityToConstructorMap: MapType<Constructable<Entity>>
+ +
+
+

A map that holds the entity type to constructor mapping

+
+
+
+
+ +

requestConfig

+
requestConfig: ODataBatchRequestConfig
+ +
+
+

Request configuration to initialize with

+
+
+
+
+ +

Readonly requests

+
requests: (GetAllRequestBuilder<Entity> | GetByKeyRequestBuilder<Entity> | ODataBatchChangeSet<CreateRequestBuilder<Entity> | UpdateRequestBuilder<Entity> | DeleteRequestBuilder<Entity>>)[]
+ +
+
+

An array of retrieve requests or change sets

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html new file mode 100644 index 0000000000..0e40f93028 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html @@ -0,0 +1,654 @@ + + + + + + ODataCreateRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataCreateRequestConfig<EntityT>

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.21.0. Use superclass instead. + OData create request configuration for an entity type.

+
+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: EntityBase

    +
    +
    +

    Type of the entity to setup a request for

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + ODataCreateRequestConfig<EntityT> +
      +
    • + ODataCreateRequestConfig +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to create a configuration for

+
+
+
+
+ +

childField

+
childField: Link<EntityBase, EntityT>
+ +
+
+

Field that links the parent entity class to the child entity class.

+
+
+
+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

default path of the according service

+
+
+
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

parentKeys

+
parentKeys: MapType<any>
+ +
+
+

Keys of the parent of the entity to create. Defined only when attempting to create child entities.

+
+
+
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+ +

Protected resourcePathAsChild

+
    +
  • resourcePathAsChild(): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html new file mode 100644 index 0000000000..5b36776f3f --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html @@ -0,0 +1,644 @@ + + + + + + ODataDeleteRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataDeleteRequestConfig<EntityT>

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.21.0. Use superclass instead. + OData delete request configuration for an entity type.

+
+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: EntityBase

    +
    +
    +

    Type of the entity to setup a request for

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + ODataDeleteRequestConfig<EntityT> +
      +
    • + ODataDeleteRequestConfig +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • WithKeys
    • +
  • WithETag
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

default path of the according service

+
+
+
+
+ +

eTag

+
eTag: string
+ +
+
+ +

Readonly entityConstructor

+
entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to create a configuration for

+
+
+
+
+ +

keys

+
keys: MapType<FieldType>
+ +
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+ +

versionIdentifierIgnored

+
versionIdentifierIgnored: boolean = false
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html new file mode 100644 index 0000000000..ba06cd92cb --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html @@ -0,0 +1,636 @@ + + + + + + ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataFunctionImportRequestConfig<ParametersT>

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.21.0. Use superclass instead. + OData function import request configuration for a set of parameters.

+
+
+
+
+
+

Type parameters

+
    +
  • +

    ParametersT

    +
    +
    +

    Type of the original parameters object

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + ODataFunctionImportRequestConfig<ParametersT> +
      +
    • + ODataFunctionImportRequestConfig +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

default path of the according service

+
+
+
+
+ +

Readonly functionImportName

+
functionImportName: string
+ +
+
+

The name of the function import.

+
+
+
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

parameters

+
parameters: FunctionImportParameters<ParametersT>
+ +
+
+

Object containing the parameters with a value and additional meta information

+
+
+
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html new file mode 100644 index 0000000000..8a4b3bd703 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html @@ -0,0 +1,688 @@ + + + + + + ODataGetAllRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataGetAllRequestConfig<EntityT>

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.21.0. Use superclass instead. + OData delete request configuration for an entity type.

+
+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: EntityBase

    +
    +
    +

    Type of the entity to setup a request for

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + ODataGetAllRequestConfig<EntityT> +
      +
    • + ODataGetAllRequestConfig +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • WithGetAllRestrictions<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

default path of the according service

+
+
+
+
+ +

Readonly entityConstructor

+
entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to create a configuration for

+
+
+
+
+ +

expands

+
expands: Expandable<EntityT>[]
+ +
+
+ +

filter

+
filter: Filterable<EntityT>
+ +
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

orderBy

+
orderBy: Orderable<EntityT>[]
+ +
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+ +

selects

+
selects: Selectable<EntityT>[]
+ +
+
+ +

skip

+
skip: number
+ +
+
+ +

top

+
top: number
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html new file mode 100644 index 0000000000..065b450b16 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html @@ -0,0 +1,644 @@ + + + + + + ODataGetByKeyRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataGetByKeyRequestConfig<EntityT>

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.21.0. Use superclass instead. + OData delete request configuration for an entity type.

+
+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: EntityBase

    +
    +
    +

    Type of the entity to setup a request for

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + ODataGetByKeyRequestConfig<EntityT> +
      +
    • + ODataGetByKeyRequestConfig +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • WithKeys
    • +
  • WithSelection<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

default path of the according service

+
+
+
+
+ +

Readonly entityConstructor

+
entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to create a configuration for

+
+
+
+
+ +

expands

+
expands: Expandable<EntityT>[]
+ +
+
+ +

keys

+
keys: MapType<FieldType>
+ +
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+ +

selects

+
selects: Selectable<EntityT>[] = []
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html new file mode 100644 index 0000000000..48304fa5f6 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html @@ -0,0 +1,666 @@ + + + + + + ODataUpdateRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ODataUpdateRequestConfig<EntityT>

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.21.0. Use superclass instead. + OData delete request configuration for an entity type.

+
+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: EntityBase

    +
    +
    +

    Type of the entity to setup a request for

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + ODataUpdateRequestConfig<EntityT> +
      +
    • + ODataUpdateRequestConfig +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • WithKeys
    • +
  • WithETag
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Accessors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Properties

+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to create a configuration for

+
+
+
+
+ +

Readonly contentType

+
contentType: string
+ +
+
+

The content type of the request

+
+
+
+
+ +

customServicePath

+
customServicePath: string
+ +
+
+ +

Readonly defaultServicePath

+
defaultServicePath: string
+ +
+
+

default path of the according service

+
+
+
+
+ +

eTag

+
eTag: string
+ +
+
+ +

keys

+
keys: MapType<FieldType>
+ +
+
+ +

method

+
method: RequestMethodType
+ +
+
+

HTTP method of the request

+
+
+
+
+ +

payload

+
payload: MapType<any> | string
+ +
+
+ +

versionIdentifierIgnored

+
versionIdentifierIgnored: boolean = false
+ +
+
+
+

Accessors

+
+ +

customHeaders

+
    +
  • get customHeaders(): MapType<string>
    • +
  • set customHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

customQueryParameters

+
    +
  • get customQueryParameters(): MapType<string>
    • +
  • set customQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+
+

Methods

+
+ +

addCustomHeaders

+
    +
  • addCustomHeaders(headers: MapType<string>): void
    • +
+ +
+
+ +

addCustomQueryParameters

+
    +
  • addCustomQueryParameters(queryParameters: MapType<string>): void
    • +
+ +
+
+ +

Protected prependDollarToQueryParameters

+
    +
  • prependDollarToQueryParameters(params: MapType<any>): MapType<any>
    • +
+ +
+
+ +

queryParameters

+
    +
  • queryParameters(): MapType<any>
    • +
+ +
+
+ +

resourcePath

+
    +
  • resourcePath(): string
    • +
+ +
+
+ +

updateWithPut

+
    +
  • updateWithPut(): void
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
  • Inherited accessor
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_core.updaterequestbuilder-1.html b/docs/api/1.21.0/classes/sap_cloud_sdk_core.updaterequestbuilder-1.html new file mode 100644 index 0000000000..da946d98d9 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_core.updaterequestbuilder-1.html @@ -0,0 +1,779 @@ + + + + + + UpdateRequestBuilder | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class UpdateRequestBuilder<EntityT>

+
+
+
+
+
+
+
+
+
+

Create OData query to update an entity.

+
+
+
+
+

Type parameters

+
    +
  • +

    EntityT: Entity

    +
    +
    +

    Type of the entity to be updated

    +
    +
    +
    • +
+
+
+

Hierarchy

+
    +
  • + MethodRequestBuilderBase<ODataUpdateRequestConfig<EntityT>> +
      +
    • + UpdateRequestBuilder +
      • +
    +
    • +
+
+
+

Implements

+
    +
  • EntityIdentifiable<EntityT>
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Properties

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new UpdateRequestBuilder(_entityConstructor: Constructable<EntityT>, _entity: EntityT): UpdateRequestBuilder
    • +
+ +
+
+
+

Properties

+
+ +

Readonly _entity

+
_entity: EntityT
+ +
+
+

Entity to be updated

+
+
+
+
+ +

Readonly _entityConstructor

+
_entityConstructor: Constructable<EntityT>
+ +
+
+

Constructor type of the entity to be updated

+
+
+
+
+ +

requestConfig

+
requestConfig: ODataUpdateRequestConfig<EntityT>
+ +
+
+

Request configuration to initialize with

+
+
+
+
+
+

Methods

+
+ +

build

+ + +
+
+ +

execute

+ + +
+
+ +

ignoreVersionIdentifier

+
    +
  • ignoreVersionIdentifier(): this
    • +
+
    +
  • + +
    +
    +

    Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

    +
    +
    +

    Returns this

    +

    this The request itself to ease chaining while executing the request

    +
    • +
+
+
+ +

ignoredFields

+
    +
  • ignoredFields(...fields: Selectable<EntityT>[]): this
    • +
+ +
+
+ +

prepare

+
    +
  • prepare(): this
    • +
+ +
+
+ +

relativeUrl

+
    +
  • relativeUrl(): string
    • +
+ +
+
+ +

replaceWholeEntityWithPut

+
    +
  • replaceWholeEntityWithPut(): this
    • +
+
    +
  • + +
    +
    +

    Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.

    +
    +
    +

    Returns this

    +

    The entity itself, to facilitate method chaining

    +
    • +
+
+
+ +

requiredFields

+
    +
  • requiredFields(...fields: Selectable<EntityT>[]): this
    • +
+ +
+
+ +

url

+ + +
+
+ +

withCustomHeaders

+
    +
  • withCustomHeaders(headers: MapType<string>): this
    • +
+ +
+
+ +

withCustomQueryParameters

+
    +
  • withCustomQueryParameters(queryParameters: MapType<string>): this
    • +
+ +
+
+ +

withCustomServicePath

+
    +
  • withCustomServicePath(servicePath: string): this
    • +
+ +
+
+ +

withCustomVersionIdentifier

+
    +
  • withCustomVersionIdentifier(etag: string): this
    • +
+
    +
  • + +
    +
    +

    Specifies a custom ETag version identifier of the entity to update.

    +
    +
    +

    Parameters

    +
      +
    • +
      etag: string
      +
      +

      Custom ETag version identifier to be sent in the header of the request

      +
      +
      • +
    +

    Returns this

    +

    The request itself to ease chaining while executing the request

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Property
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Inherited property
    • +
  • Inherited method
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_generator.globalnameformatter.html b/docs/api/1.21.0/classes/sap_cloud_sdk_generator.globalnameformatter.html new file mode 100644 index 0000000000..295d120913 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_generator.globalnameformatter.html @@ -0,0 +1,261 @@ + + + + + + GlobalNameFormatter | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class GlobalNameFormatter

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + GlobalNameFormatter +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+ + +
+
+
+

Methods

+
+ +

uniqueDirectoryName

+
    +
  • uniqueDirectoryName(directoryName: string, originalFileName: string): string
    • +
+ +
+
+ +

uniqueNpmPackageName

+
    +
  • uniqueNpmPackageName(npmPackageName: string, originalFileName: string): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/classes/sap_cloud_sdk_generator.servicenameformatter.html b/docs/api/1.21.0/classes/sap_cloud_sdk_generator.servicenameformatter.html new file mode 100644 index 0000000000..c95cc70074 --- /dev/null +++ b/docs/api/1.21.0/classes/sap_cloud_sdk_generator.servicenameformatter.html @@ -0,0 +1,492 @@ + + + + + + ServiceNameFormatter | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Class ServiceNameFormatter

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ServiceNameFormatter +
    • +
+
+
+

Index

+
+
+
+

Constructors

+ +
+
+

Methods

+ +
+
+
+
+
+

Constructors

+
+ +

constructor

+
    +
  • new ServiceNameFormatter(entitySetNames: string[], complexTypeNames: string[], functionImportNames: string[]): ServiceNameFormatter
    • +
+ +
+
+
+

Methods

+
+ +

directoryToSpeakingModuleName

+
    +
  • directoryToSpeakingModuleName(packageName: string): string
    • +
+ +
+
+ +

originalToComplexTypeName

+
    +
  • originalToComplexTypeName(str: string): string
    • +
+ +
+
+ +

originalToEntityClassName

+
    +
  • originalToEntityClassName(entitySetName: string): string
    • +
+ +
+
+ +

originalToFunctionImportName

+
    +
  • originalToFunctionImportName(str: string): string
    • +
+ +
+
+ +

originalToInstancePropertyName

+
    +
  • originalToInstancePropertyName(originalContainerTypeName: string, originalPropertyName: string): string
    • +
+ +
+
+ +

originalToNavigationPropertyName

+
    +
  • originalToNavigationPropertyName(entitySetName: string, originalPropertyName: string): string
    • +
+ +
+
+ +

originalToParameterName

+
    +
  • originalToParameterName(originalFunctionImportName: string, originalParameterName: string): string
    • +
+ +
+
+ +

originalToServiceName

+
    +
  • originalToServiceName(name: string): string
    • +
+ +
+
+ +

originalToStaticPropertyName

+
    +
  • originalToStaticPropertyName(originalContainerTypeName: string, originalPropertyName: string): string
    • +
+ +
+
+ +

typeNameToFactoryName

+
    +
  • typeNameToFactoryName(str: string, reservedNames: Set<string>): string
    • +
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
  • Constructor
    • +
  • Method
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/enums/sap_cloud_sdk_core.destinationorigin-1.html b/docs/api/1.21.0/enums/sap_cloud_sdk_core.destinationorigin-1.html new file mode 100644 index 0000000000..ca7be2381d --- /dev/null +++ b/docs/api/1.21.0/enums/sap_cloud_sdk_core.destinationorigin-1.html @@ -0,0 +1,195 @@ + + + + + + DestinationOrigin | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration DestinationOrigin

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.0.1.

+

Represents the origin of a destination in a multi-tenant setup on SAP Cloud Platform.

+

In a multi-tenant application on SAP Cloud Platform, destinations can be defined both on provider account level ("PaaS tenant") as well as on the level of each subscriber account ("SaaS tenant").

+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

Provider

+
Provider: = "provider"
+ +
+
+ +

Subscriber

+
Subscriber: = "subscriber"
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/enums/sap_cloud_sdk_core.httpmethod-1.html b/docs/api/1.21.0/enums/sap_cloud_sdk_core.httpmethod-1.html new file mode 100644 index 0000000000..57e50c41f1 --- /dev/null +++ b/docs/api/1.21.0/enums/sap_cloud_sdk_core.httpmethod-1.html @@ -0,0 +1,263 @@ + + + + + + HttpMethod | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration HttpMethod

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.20.0. Use method string directly, e. g. 'get' or 'GET'.

+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

DELETE

+
DELETE: = "DELETE"
+ +
+
+ +

GET

+
GET: = "GET"
+ +
+
+ +

HEAD

+
HEAD: = "HEAD"
+ +
+
+ +

OPTIONS

+
OPTIONS: = "OPTIONS"
+ +
+
+ +

PATCH

+
PATCH: = "PATCH"
+ +
+
+ +

POST

+
POST: = "POST"
+ +
+
+ +

PUT

+
PUT: = "PUT"
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/enums/sap_cloud_sdk_core.isolationstrategy-1.html b/docs/api/1.21.0/enums/sap_cloud_sdk_core.isolationstrategy-1.html new file mode 100644 index 0000000000..0f3117c3f1 --- /dev/null +++ b/docs/api/1.21.0/enums/sap_cloud_sdk_core.isolationstrategy-1.html @@ -0,0 +1,219 @@ + + + + + + IsolationStrategy | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration IsolationStrategy

+
+
+
+
+
+
+
+
+
+

Enumerator that selects the isolation type of destination in cache.

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

No_Isolation

+
No_Isolation: = "NoIsolation"
+ +
+
+ +

Tenant

+
Tenant: = "Tenant"
+ +
+
+ +

Tenant_User

+
Tenant_User: = "TenantUser"
+ +
+
+ +

User

+
User: = "User"
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/enums/sap_cloud_sdk_core.protocol-1.html b/docs/api/1.21.0/enums/sap_cloud_sdk_core.protocol-1.html new file mode 100644 index 0000000000..39b71566aa --- /dev/null +++ b/docs/api/1.21.0/enums/sap_cloud_sdk_core.protocol-1.html @@ -0,0 +1,235 @@ + + + + + + Protocol | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration Protocol

+
+
+
+
+
+
+
+
+
+

Protocol enumeration, either 'http' or 'https'.

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+

Functions

+ +
+
+
+
+
+

Enumeration members

+
+ +

HTTP

+
HTTP: = "http"
+ +
+
+ +

HTTPS

+
HTTPS: = "https"
+ +
+
+
+

Functions

+
+ +

of

+
    +
  • of(protocol: string): Protocol | undefined
    • +
+
    +
  • + +
    +
    +

    Get Protocol from its string representation.

    +
    +
    +

    Parameters

    +
      +
    • +
      protocol: string
      +
      +

      Protocol as string, either 'http' or 'https'.

      +
      +
      • +
    +

    Returns Protocol | undefined

    +

    Either the matching protocol or undefined

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/enums/sap_cloud_sdk_core.proxystrategy-2.html b/docs/api/1.21.0/enums/sap_cloud_sdk_core.proxystrategy-2.html new file mode 100644 index 0000000000..362c0019c6 --- /dev/null +++ b/docs/api/1.21.0/enums/sap_cloud_sdk_core.proxystrategy-2.html @@ -0,0 +1,206 @@ + + + + + + ProxyStrategy | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration ProxyStrategy

+
+
+
+
+
+
+
+
+
+

Enum representing the different strategies for proxying request. Possible situations are "NO_PROXY", use the connectivity service proxy for On-Premise connection or a usual web proxy. + See also ProxyConfiguration for more details.

+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

INTERNET_PROXY

+
INTERNET_PROXY:
+ +
+
+ +

NO_PROXY

+
NO_PROXY:
+ +
+
+ +

ON_PREMISE_PROXY

+
ON_PREMISE_PROXY:
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/enums/sap_cloud_sdk_generator.vdmfunctionimportreturntypecategory.html b/docs/api/1.21.0/enums/sap_cloud_sdk_generator.vdmfunctionimportreturntypecategory.html new file mode 100644 index 0000000000..44eaa330d0 --- /dev/null +++ b/docs/api/1.21.0/enums/sap_cloud_sdk_generator.vdmfunctionimportreturntypecategory.html @@ -0,0 +1,212 @@ + + + + + + VdmFunctionImportReturnTypeCategory | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Enumeration VdmFunctionImportReturnTypeCategory

+
+
+
+
+
+
+
+

Index

+
+
+
+

Enumeration members

+ +
+
+
+
+
+

Enumeration members

+
+ +

COMPLEX_TYPE

+
COMPLEX_TYPE:
+ +
+
+ +

EDM_TYPE

+
EDM_TYPE:
+ +
+
+ +

ENTITY

+
ENTITY:
+ +
+
+ +

VOID

+
VOID:
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/globals.html b/docs/api/1.21.0/globals.html new file mode 100644 index 0000000000..cfd665d0d7 --- /dev/null +++ b/docs/api/1.21.0/globals.html @@ -0,0 +1,143 @@ + + + + + + SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

SAP Cloud SDK for JavaScript / TypeScript - v1.21.0

+
+
+
+
+
+
+
+

Index

+
+
+
+

Modules

+ +
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/index.html b/docs/api/1.21.0/index.html new file mode 100644 index 0000000000..99d1ccdc1c --- /dev/null +++ b/docs/api/1.21.0/index.html @@ -0,0 +1,146 @@ + + + + + + SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

SAP Cloud SDK for JavaScript / TypeScript - v1.21.0

+
+
+
+
+
+
+
+ +

Version: 1.21.0

+ +

The SAP Cloud SDK for JavaScript and TypeScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Cloud Platform.

+

You can find tutorials that showcase some of the typical use cases on developers.sap.com. + If you have questions, you can reach out to us on StackOverflow using the tag sap-cloud-sdk and on answers.sap.com using the tag SAP Cloud SDK. + Also, you can browse our release notes to check out what's new in each version.

+ +

More Helpful Links

+ + +
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_analytics.usageanalyticsoptions.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_analytics.usageanalyticsoptions.html new file mode 100644 index 0000000000..753d0e8f86 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_analytics.usageanalyticsoptions.html @@ -0,0 +1,210 @@ + + + + + + UsageAnalyticsOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface UsageAnalyticsOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + UsageAnalyticsOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional event_type

+
event_type: undefined | string
+ +
+
+ +

Optional idsitesub

+
idsitesub: undefined | string
+ +
+
+ +

Optional uri

+
uri: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.cachingoptions-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.cachingoptions-1.html new file mode 100644 index 0000000000..3f6695ef1f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.cachingoptions-1.html @@ -0,0 +1,204 @@ + + + + + + CachingOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface CachingOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + CachingOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional isolationStrategy

+
isolationStrategy: IsolationStrategy
+ +
+
+

The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. + By default, IsolationStrategy.Tenant is set.

+
+
+
+
+ +

Optional useCache

+
useCache: undefined | false | true
+ +
+
+

A boolean value that indicates whether to read destinations from cache.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.clientcredentials-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.clientcredentials-1.html new file mode 100644 index 0000000000..753bb62c5e --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.clientcredentials-1.html @@ -0,0 +1,193 @@ + + + + + + ClientCredentials | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ClientCredentials

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ClientCredentials +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

password

+
password: string
+ +
+
+ +

username

+
username: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.completedecodedjwt-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.completedecodedjwt-1.html new file mode 100644 index 0000000000..5fcc4c0732 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.completedecodedjwt-1.html @@ -0,0 +1,459 @@ + + + + + + CompleteDecodedJWT | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface CompleteDecodedJWT

+
+
+
+
+
+
+
+
+
+

Interface to represent header and payload of a JWT.

+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional aud

+
aud: string[]
+ +
+
+ +

Optional email

+
email: undefined | string
+ +
+
+ +

Optional exp

+
exp: undefined | number
+ +
+
+ +

Optional family_name

+
family_name: undefined | string
+ +
+
+ +

Optional given_name

+
given_name: undefined | string
+ +
+
+ +

header

+
header: JWTHeader
+ +
+
+ +

Optional iat

+
iat: undefined | number
+ +
+
+ +

Optional iss

+
iss: undefined | string
+ +
+
+ +

Optional jti

+
jti: undefined | string
+ +
+
+ +

Optional nbf

+
nbf: undefined | string
+ +
+
+ +

payload

+
payload: JWTPayload
+ +
+
+ +

Optional scope

+
scope: string[]
+ +
+
+ +

signature

+
signature: string
+ +
+
+ +

Optional sub

+
sub: undefined | string
+ +
+
+ +

Optional user_id

+
user_id: undefined | string
+ +
+
+ +

Optional user_name

+
user_name: undefined | string
+ +
+
+ +

Optional xs.user.attributes

+
xs.user.attributes: Map<string, string[]>
+ +
+
+ +

Optional zdn

+
zdn: undefined | string
+ +
+
+ +

Optional zid

+
zid: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.decodedjwt-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.decodedjwt-1.html new file mode 100644 index 0000000000..ac53c07086 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.decodedjwt-1.html @@ -0,0 +1,431 @@ + + + + + + DecodedJWT | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DecodedJWT

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.20.0. Use JWTPayload if you want to represent the decoded JWT payload or CompleteDecodedJWT for the full decoded object. + Interface to represent the payload of a JWT.

+
+
+
+
+
+

Hierarchy

+ +
+
+

Indexable

+
[otherKey: string]: any
+
+
+
deprecated
+

Since v1.20.0. Use JWTPayload if you want to represent the decoded JWT payload or CompleteDecodedJWT for the full decoded object. + Interface to represent the payload of a JWT.

+
+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional aud

+
aud: string[]
+ +
+
+ +

Optional email

+
email: undefined | string
+ +
+
+ +

Optional exp

+
exp: undefined | number
+ +
+
+ +

Optional family_name

+
family_name: undefined | string
+ +
+
+ +

Optional given_name

+
given_name: undefined | string
+ +
+
+ +

Optional iat

+
iat: undefined | number
+ +
+
+ +

Optional iss

+
iss: undefined | string
+ +
+
+ +

Optional jti

+
jti: undefined | string
+ +
+
+ +

Optional nbf

+
nbf: undefined | string
+ +
+
+ +

Optional scope

+
scope: string[]
+ +
+
+ +

Optional sub

+
sub: undefined | string
+ +
+
+ +

Optional user_id

+
user_id: undefined | string
+ +
+
+ +

Optional user_name

+
user_name: undefined | string
+ +
+
+ +

Optional xs.user.attributes

+
xs.user.attributes: Map<string, string[]>
+ +
+
+ +

Optional zdn

+
zdn: undefined | string
+ +
+
+ +

Optional zid

+
zid: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destination-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destination-1.html new file mode 100644 index 0000000000..17fb2df7c7 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destination-1.html @@ -0,0 +1,636 @@ + + + + + + Destination | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Destination

+
+
+
+
+
+
+
+
+
+

A resolved destination containing information needed to execute requests, such as the system URL.

+
+

You can create a destination as a local object when supplying all necessary information, or it could be retrieved from the destination service on SAP Cloud Platform (via DestinationNameAndJwt). + When creating a local object representing a destination, you need to supply at least the url and, if required by the target system, valid credentials with username and password.

+
+
+
+

Hierarchy

+
    +
  • + Destination +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional authTokens

+
authTokens: DestinationAuthToken[] | null
+ +
+
+

Authentication tokens returned from destination service on SAP Cloud Platform, optional.

+
+
+
+
+ +

Optional authentication

+
authentication: AuthenticationType
+ +
+
+

Type of authentication to use, optional.

+
+

Defaults to NoAuthentication, unless username and password are provided, in which case the default is BasicAuthentication.

+
+
+
+ +

Optional certificates

+
certificates: DestinationCertificate[]
+ +
+
+

Array of certificates used for authentication type ClientCertificateAuthentication.

+
+
+
+
+ +

Optional clientId

+
clientId: undefined | string
+ +
+
+

Client Id used to retrieve access token for "OAuth2ClientCredentials" authentication.

+
+
+
+
+ +

Optional clientSecret

+
clientSecret: undefined | string
+ +
+
+

Client Secret used to retrieve access token for "OAuth2ClientCredentials" authentication.

+
+
+
+
+ +

Optional cloudConnectorLocationId

+
cloudConnectorLocationId: undefined | string
+ +
+
+

Location ID of the Cloud Connector to be used for connection to an On-Premise system. Optional. Corresponds to property "CloudConnectorLocationId" in the additional properties of a destination.

+
+
+
+
+ +

Optional isTestDestination

+
isTestDestination: undefined | false | true
+ +
+
+

Flag indicating whether the destination is for test purpose. Should be "undefined" or "false" for non-mocked destinations.

+
+
+
+
+ +

Optional isTrustingAllCertificates

+
isTrustingAllCertificates: undefined | false | true
+ +
+
+

Flag indicating whether all certificates should be accepted when communicating with the destination. Should not be "true" in production.

+
+
+
+
+ +

Optional keyStoreName

+
keyStoreName: undefined | string
+ +
+
+

Name of the key store/certificate to be used for ClientCertificateAuthentication.

+
+
+
+
+ +

Optional keyStorePassword

+
keyStorePassword: undefined | string
+ +
+
+

Password of the key store/certificate to be used for ClientCertificateAuthentication.

+
+
+
+
+ +

Optional name

+
name: string | null
+ +
+
+

Name of the destination retrieved from SAP Cloud Platform, optional.

+
+
+
+
+ +

Optional origin

+
origin: DestinationOrigin
+ +
+
+
deprecated
+

Since v1.0.1.

+

Origin of the destination in a multi-tenant setup on SAP Cloud Platform (either from provider or subscriber account), optional.

+
+
+
+
+
+ +

Optional originalProperties

+
originalProperties: undefined | {}
+ +
+
+

Further properties of the destination as defined in destination service on SAP Cloud Platform, possibly empty.

+
+
+
+
+ +

Optional password

+
password: string | null
+ +
+
+

Password to use for basic authentication, optional if other means of authentication shall be used.

+
+
+
+
+ +

Optional proxyConfiguration

+
proxyConfiguration: ProxyConfiguration
+ +
+
+

ProxyConfiguration for on-premise connectivity and http(s) web proxies. Is present if proxyType of the destination equals "OnPremise" or environment variables [http_proxy] or [https_proxy] are set See ProxyConfiguration.

+
+
+
+
+ +

Optional proxyType

+
proxyType: DestinationProxyType
+ +
+
+

Proxy type to specify whether the target resides on-premise, optional, not used.

+
+
+
+
+ +

Optional sapClient

+
sapClient: string | undefined | null
+ +
+
+

Client to target in an SAP system, will be added as HTTP header sap-client if set, optional.

+
+
+
+
+ +

Optional systemUser

+
systemUser: undefined | string
+ +
+
+

System user to be used for OAuth2SAMLBearerAssertion authentication type.

+
+
+
+
+ +

Optional tokenServicePassword

+
tokenServicePassword: undefined | string
+ +
+
+

Password for tokenServiceUser (if required).

+
+
+
+
+ +

Optional tokenServiceUrl

+
tokenServiceUrl: undefined | string
+ +
+
+

URL to retrieve access token for "OAuth2ClientCredentials" authentication.

+
+
+
+
+ +

Optional tokenServiceUser

+
tokenServiceUser: undefined | string
+ +
+
+

User for basic authentication to OAuth server (if required).

+
+
+
+
+ +

Optional type

+
type: "HTTP" | "LDAP" | "MAIL" | "RFC"
+ +
+
+

The type of the destination, defaults to 'HTTP'. The SAP Cloud SDK only understands destinations of type 'HTTP'.

+
+
+
+
+ +

url

+
url: string
+ +
+
+

Base URL for calls to this destination, mandatory.

+
+

The URL needs to define at least scheme (protocol like http:// or https://) and host. + The path for requests against this destination will be appended to the path defined in the URL as a new path segment.

+
+
+
+ +

Optional username

+
username: string | null
+ +
+
+

Username to use for basic authentication, optional if other means of authentication shall be used.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationaccessoroptions-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationaccessoroptions-1.html new file mode 100644 index 0000000000..7bab68785d --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationaccessoroptions-1.html @@ -0,0 +1,203 @@ + + + + + + DestinationAccessorOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationAccessorOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + DestinationAccessorOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional selectionStrategy

+
selectionStrategy: DestinationSelectionStrategy
+ +
+
+

Method that implements the selection strategy of the retrieved destination. Uses subscriberFirst per default. Use the selector helper DestinationSelectionStrategies to select the appropriate selection strategy.

+
+
+
+
+ +

Optional userJwt

+
userJwt: undefined | string
+ +
+
+

The user token of the current request.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationauthtoken-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationauthtoken-1.html new file mode 100644 index 0000000000..a5cb0562e3 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationauthtoken-1.html @@ -0,0 +1,228 @@ + + + + + + DestinationAuthToken | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationAuthToken

+
+
+
+
+
+
+
+
+
+

Represents authentication token returned from destination service.

+
+
+
+
+

Hierarchy

+
    +
  • + DestinationAuthToken +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

error

+
error: string | null
+ +
+
+ +

expiresIn

+
expiresIn: string
+ +
+
+ +

type

+
type: string
+ +
+
+ +

value

+
value: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcachingoptions-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcachingoptions-1.html new file mode 100644 index 0000000000..313a29c58f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcachingoptions-1.html @@ -0,0 +1,213 @@ + + + + + + DestinationCachingOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationCachingOptions

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since version 1.16.0. Use CachingOptions instead.

+
+
+
+
+
+

Hierarchy

+
    +
  • + DestinationCachingOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional isolationStrategy

+
isolationStrategy: IsolationStrategy
+ +
+
+

The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. + By default, IsolationStrategy.Tenant is set.

+
+
+
+
+ +

Optional useCache

+
useCache: undefined | false | true
+ +
+
+

A boolean value that indicates whether to read destinations from cache.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcertificate-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcertificate-1.html new file mode 100644 index 0000000000..a3e18e230c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationcertificate-1.html @@ -0,0 +1,229 @@ + + + + + + DestinationCertificate | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationCertificate

+
+
+
+
+
+
+
+
+
+

Represents a certificate attached to a destination.

+
+
+
+
+

Hierarchy

+
    +
  • + DestinationCertificate +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

content

+
content: string
+ +
+
+

Content of the certificate as base64 encoded binary.

+
+
+
+
+ +

name

+
name: string
+ +
+
+

Name of the certificate file.

+
+
+
+
+ +

type

+
type: string
+ +
+
+

Type of the certificate.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationconfiguration-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationconfiguration-1.html new file mode 100644 index 0000000000..b7d768377f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationconfiguration-1.html @@ -0,0 +1,391 @@ + + + + + + DestinationConfiguration | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationConfiguration

+
+
+
+
+
+
+
+
+
+

Configuration of a destination as it is available through the destination service.

+
+
+
+
+

Hierarchy

+
    +
  • + DestinationConfiguration +
    • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Configuration of a destination as it is available through the destination service.

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional Authentication

+
Authentication: AuthenticationType
+ +
+
+ +

Optional Name

+
Name: undefined | string
+ +
+
+ +

Optional Password

+
Password: undefined | string
+ +
+
+ +

Optional ProxyType

+
ProxyType: undefined | string
+ +
+
+ +

Optional SystemUser

+
SystemUser: undefined | string
+ +
+
+ +

Optional TrustAll

+
TrustAll: undefined | string
+ +
+
+ +

Optional Type

+
Type: "HTTP" | "LDAP" | "MAIL" | "RFC"
+ +
+
+ +

URL

+
URL: string
+ +
+
+ +

Optional User

+
User: undefined | string
+ +
+
+ +

Optional clientId

+
clientId: undefined | string
+ +
+
+ +

Optional clientSecret

+
clientSecret: undefined | string
+ +
+
+ +

Optional sap-client

+
sap-client: undefined | string
+ +
+
+ +

Optional tokenServicePass

+
tokenServicePass: undefined | string
+ +
+
+ +

Optional tokenServiceURL

+
tokenServiceURL: undefined | string
+ +
+
+ +

Optional tokenServiceUsername

+
tokenServiceUsername: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions-1.html new file mode 100644 index 0000000000..8b97a13e4f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions-1.html @@ -0,0 +1,191 @@ + + + + + + DestinationForServiceBindingsOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationForServiceBindingsOptions

+
+
+
+
+
+
+
+
+
+

Options to customize the behavior of destinationForServiceBinding.

+
+
+
+
+

Hierarchy

+
    +
  • + DestinationForServiceBindingsOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional transformationFn

+
transformationFn: undefined | ((serviceBinding: ServiceBinding) => Destination)
+ +
+
+

Custom transformation function to control how a Destination is built from the given ServiceBinding.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig-1.html new file mode 100644 index 0000000000..87b2610d0f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig-1.html @@ -0,0 +1,221 @@ + + + + + + DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationHttpRequestConfig

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + DestinationHttpRequestConfig +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

baseURL

+
baseURL: string
+ +
+
+ +

headers

+
headers: MapType<string>
+ +
+
+ +

Optional httpAgent

+
httpAgent: http.Agent
+ +
+
+ +

Optional httpsAgent

+
httpsAgent: http.Agent
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationjson-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationjson-1.html new file mode 100644 index 0000000000..865191a7d1 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationjson-1.html @@ -0,0 +1,223 @@ + + + + + + DestinationJson | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationJson

+
+
+
+
+
+
+
+
+
+

Destination configuration alongside authtokens and certificates.

+
+
+
+
+

Hierarchy

+
    +
  • + DestinationJson +
    • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Destination configuration alongside authtokens and certificates.

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional authTokens

+
authTokens: MapType<string>[]
+ +
+
+ +

Optional certificates

+
certificates: MapType<string>[]
+ +
+
+ +

destinationConfiguration

+
destinationConfiguration: DestinationConfiguration
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationnameandjwt-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationnameandjwt-1.html new file mode 100644 index 0000000000..602a965648 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationnameandjwt-1.html @@ -0,0 +1,216 @@ + + + + + + DestinationNameAndJwt | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationNameAndJwt

+
+
+
+
+
+
+
+
+
+

Declaration of a destination to be retrieved from an environment variable or from the destination service on SAP Cloud Platform.

+
+

Use an object of this interface to specify which destination shall be used when executing a request. + The destination will be retrieved via its DestinationNameAndJwt.destinationName according to the following algorithm:

+
    +
  1. If a destination of this DestinationNameAndJwt.destinationName is defined in the environment variable destinations (if available), it will be converted into a Destination and used for the request.
    2. +
  2. Otherwise, the destination service on SAP Cloud Platform is queried for a destination with the given DestinationNameAndJwt.destinationName, using the access token provided as value of property jwt.
    3. +
+
+
+
+

Hierarchy

+
    +
  • + DestinationNameAndJwt +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

destinationName

+
destinationName: string
+ +
+
+

Name of the destination to retrieve, mandatory.

+
+
+
+
+ +

Optional jwt

+
jwt: undefined | string
+ +
+
+

An access token for the XSUAA service on SAP Cloud Platform, provided as a JSON Web Token, only mandatory when destination shall be retrieved from destination service on SAP Cloud Platform.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationservicecredentials-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationservicecredentials-1.html new file mode 100644 index 0000000000..1b1b80e423 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.destinationservicecredentials-1.html @@ -0,0 +1,326 @@ + + + + + + DestinationServiceCredentials | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DestinationServiceCredentials

+
+
+
+
+
+
+
+
+
+

Credentials for the Destination service.

+
+
+
+
+

Hierarchy

+
    +
  • + DestinationServiceCredentials +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

clientid

+
clientid: string
+ +
+
+ +

clientsecret

+
clientsecret: string
+ +
+
+ +

identityzone

+
identityzone: string
+ +
+
+ +

instanceid

+
instanceid: string
+ +
+
+ +

tenantid

+
tenantid: string
+ +
+
+ +

tenantmode

+
tenantmode: string
+ +
+
+ +

uaadomain

+
uaadomain: string
+ +
+
+ +

uri

+
uri: string
+ +
+
+ +

url

+
url: string
+ +
+
+ +

verificationkey

+
verificationkey: string
+ +
+
+ +

xsappname

+
xsappname: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpagentconfig-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpagentconfig-1.html new file mode 100644 index 0000000000..80ec2be829 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpagentconfig-1.html @@ -0,0 +1,186 @@ + + + + + + HttpAgentConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface HttpAgentConfig

+
+
+
+
+
+
+
+
+
+

Interface for the http-agent within the Axios request config.

+
+
+
+
+

Hierarchy

+
    +
  • + HttpAgentConfig +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

httpAgent

+
httpAgent: Agent
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpreponse-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpreponse-1.html new file mode 100644 index 0000000000..332c07235f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpreponse-1.html @@ -0,0 +1,234 @@ + + + + + + HttpReponse | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface HttpReponse

+
+
+
+
+
+
+
+
+
+
deprecated
+

Since v1.6.4. Use HttpResponse instead.

+
+
+
+
+
+

Hierarchy

+
    +
  • + KnownHttpResponseFields +
      +
    • + HttpReponse +
      • +
    +
    • +
+
+
+

Indexable

+
[otherKey: string]: any
+
+
+
deprecated
+

Since v1.6.4. Use HttpResponse instead.

+
+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

data

+
data: any
+ +
+
+ +

headers

+
headers: any
+ +
+
+ +

status

+
status: number
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httprequestconfig-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httprequestconfig-1.html new file mode 100644 index 0000000000..a702bd3c48 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httprequestconfig-1.html @@ -0,0 +1,312 @@ + + + + + + HttpRequestConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface HttpRequestConfig

+
+
+
+
+
+
+
+
+
+

This interface is compatible with AxiosRequestConfig.

+
+
+
+
+

Hierarchy

+
    +
  • + HttpRequestConfig +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional data

+
data: any
+ +
+
+ +

Optional headers

+
headers: any
+ +
+
+ +

Optional httpAgent

+
httpAgent: any
+ +
+
+ +

Optional httpsAgent

+
httpsAgent: any
+ +
+
+ +

Optional maxContentLength

+
maxContentLength: undefined | number
+ +
+
+ +

method

+
method: Method
+ +
+
+ +

Optional params

+
params: MapType<string>
+ +
+
+ +

Optional proxy

+
proxy: undefined | false
+ +
+
+ +

Optional timeout

+
timeout: undefined | number
+ +
+
+ +

Optional url

+
url: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpresponse-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpresponse-1.html new file mode 100644 index 0000000000..a0c2f08842 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpresponse-1.html @@ -0,0 +1,218 @@ + + + + + + HttpResponse | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface HttpResponse

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + KnownHttpResponseFields +
      +
    • + HttpResponse +
      • +
    +
    • +
+
+
+

Indexable

+
[otherKey: string]: any
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

data

+
data: any
+ +
+
+ +

headers

+
headers: any
+ +
+
+ +

status

+
status: number
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpsagentconfig-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpsagentconfig-1.html new file mode 100644 index 0000000000..4c7ee68bf5 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.httpsagentconfig-1.html @@ -0,0 +1,186 @@ + + + + + + HttpsAgentConfig | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface HttpsAgentConfig

+
+
+
+
+
+
+
+
+
+

Interface for the https-agent within the Axios request config.

+
+
+
+
+

Hierarchy

+
    +
  • + HttpsAgentConfig +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

httpsAgent

+
httpsAgent: Agent
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtheader-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtheader-1.html new file mode 100644 index 0000000000..818995117d --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtheader-1.html @@ -0,0 +1,214 @@ + + + + + + JWTHeader | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface JWTHeader

+
+
+
+
+
+
+
+
+
+

Interface to represent the basic properties of a jwt header

+
+
+
+
+

Hierarchy

+
    +
  • + JWTHeader +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

alg

+
alg: string
+ +
+
+ +

Optional jku

+
jku: undefined | string
+ +
+
+ +

typ

+
typ: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtpayload-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtpayload-1.html new file mode 100644 index 0000000000..203261109d --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.jwtpayload-1.html @@ -0,0 +1,425 @@ + + + + + + JWTPayload | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface JWTPayload

+
+
+
+
+
+
+
+
+
+

Interface to represent the payload of a JWT.

+
+
+
+
+

Hierarchy

+ +
+
+

Indexable

+
[otherKey: string]: any
+
+
+

Interface to represent the payload of a JWT.

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional aud

+
aud: string[]
+ +
+
+ +

Optional email

+
email: undefined | string
+ +
+
+ +

Optional exp

+
exp: undefined | number
+ +
+
+ +

Optional family_name

+
family_name: undefined | string
+ +
+
+ +

Optional given_name

+
given_name: undefined | string
+ +
+
+ +

Optional iat

+
iat: undefined | number
+ +
+
+ +

Optional iss

+
iss: undefined | string
+ +
+
+ +

Optional jti

+
jti: undefined | string
+ +
+
+ +

Optional nbf

+
nbf: undefined | string
+ +
+
+ +

Optional scope

+
scope: string[]
+ +
+
+ +

Optional sub

+
sub: undefined | string
+ +
+
+ +

Optional user_id

+
user_id: undefined | string
+ +
+
+ +

Optional user_name

+
user_name: undefined | string
+ +
+
+ +

Optional xs.user.attributes

+
xs.user.attributes: Map<string, string[]>
+ +
+
+ +

Optional zdn

+
zdn: undefined | string
+ +
+
+ +

Optional zid

+
zid: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.proxyconfiguration-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.proxyconfiguration-1.html new file mode 100644 index 0000000000..6240a2342b --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.proxyconfiguration-1.html @@ -0,0 +1,260 @@ + + + + + + ProxyConfiguration | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ProxyConfiguration

+
+
+
+
+
+
+
+
+
+

Proxy settings for connecting to an on-premise destination via connectivity proxy or web proxies. + The ProxyConfiguration is undefined in most cases. The logic for setting it is as follow:

+
    +
  • If the destination has proxy type "OnPremise" the connectivity service proxy is used.
    • +
  • Depending on the protocol in the destination URL the proxy environment variables http_proxy and https_proxy are considered.
    • +
+
+

Valid form for the variable is http://user:password@host:port where everything besides the host is optional. + For user and password non alphanumeric characters need to be percent-encoded. + Note: The [no_proxy] environment variables contains a list of URLs for which no proxy will be used even if [http_proxy, https_proxy] are set. + Wildcards like *.some.domain.com are not supported while checking the no_proxy env.

+
+
+
+

Hierarchy

+
    +
  • + ProxyConfiguration +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional headers

+
headers: undefined | { Proxy-Authorization: string; SAP-Connectivity-Authentication?: undefined | string }
+ +
+
+

HTTP headers to be added to a request if tunneled through the proxy. + If the request is going to an OnPremise system via the connectivity proxy, the header contains the 'Proxy-Authorization' and + the 'SAP-Connectivity-Authentication' header if a JWT is present on the current request. + For web proxies only the 'Proxy-Authorization' enter the header fields if provided.

+
+
+
+
+ +

host

+
host: string
+ +
+
+

The host of the proxy.

+
+
+
+
+ +

port

+
port: number
+ +
+
+

The port of the proxy.

+
+
+
+
+ +

protocol

+
protocol: Protocol
+ +
+
+

The protocol used by the proxy

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic-1.html new file mode 100644 index 0000000000..8b593a5be4 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic-1.html @@ -0,0 +1,270 @@ + + + + + + RegisteredJWTClaimsBasic | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RegisteredJWTClaimsBasic

+
+
+
+
+
+
+
+
+
+

Interface to represent the basic properties like issuer, audience etc.

+
+
+
+
+

Hierarchy

+
    +
  • + RegisteredJWTClaimsBasic +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional aud

+
aud: string[]
+ +
+
+ +

Optional exp

+
exp: undefined | number
+ +
+
+ +

Optional iat

+
iat: undefined | number
+ +
+
+ +

Optional iss

+
iss: undefined | string
+ +
+
+ +

Optional jti

+
jti: undefined | string
+ +
+
+ +

Optional nbf

+
nbf: undefined | string
+ +
+
+ +

Optional sub

+
sub: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html new file mode 100644 index 0000000000..fe61d03fcb --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html @@ -0,0 +1,200 @@ + + + + + + RegisteredJWTClaimsTenant | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RegisteredJWTClaimsTenant

+
+
+
+
+
+
+
+
+
+

Keys in the JWT related to the user

+
+
+
+
+

Hierarchy

+
    +
  • + RegisteredJWTClaimsTenant +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional zdn

+
zdn: undefined | string
+ +
+
+ +

Optional zid

+
zid: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html new file mode 100644 index 0000000000..5cfd43e546 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html @@ -0,0 +1,270 @@ + + + + + + RegisteredJWTClaimsUser | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface RegisteredJWTClaimsUser

+
+
+
+
+
+
+
+
+
+

Keys in the JWT related to the user

+
+
+
+
+

Hierarchy

+
    +
  • + RegisteredJWTClaimsUser +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional email

+
email: undefined | string
+ +
+
+ +

Optional family_name

+
family_name: undefined | string
+ +
+
+ +

Optional given_name

+
given_name: undefined | string
+ +
+
+ +

Optional scope

+
scope: string[]
+ +
+
+ +

Optional user_id

+
user_id: undefined | string
+ +
+
+ +

Optional user_name

+
user_name: undefined | string
+ +
+
+ +

Optional xs.user.attributes

+
xs.user.attributes: Map<string, string[]>
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.resilienceoptions-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.resilienceoptions-1.html new file mode 100644 index 0000000000..3c5d2d565f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.resilienceoptions-1.html @@ -0,0 +1,184 @@ + + + + + + ResilienceOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ResilienceOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ResilienceOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional enableCircuitBreaker

+
enableCircuitBreaker: undefined | false | true
+ +
+
+

A boolean value that indicates whether to execute request to SCP-CF services using circuit breaker.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.scope.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.scope.html new file mode 100644 index 0000000000..198370e68b --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.scope.html @@ -0,0 +1,186 @@ + + + + + + Scope | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Scope

+
+
+
+
+
+
+
+
+
+

Representation of the scope. A scope is assigned to a user via role-collection in cloud foundry.

+
+
+
+
+

Hierarchy

+
    +
  • + Scope +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.service-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.service-1.html new file mode 100644 index 0000000000..87f4b7166c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.service-1.html @@ -0,0 +1,225 @@ + + + + + + Service | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Service

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + Service +
    • +
+
+
+

Indexable

+
[other: string]: any
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

credentials

+
credentials: ServiceCredentials
+ +
+
+ +

label

+
label: string
+ +
+
+ +

name

+
name: string
+ +
+
+ +

tags

+
tags: string[]
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicebinding-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicebinding-1.html new file mode 100644 index 0000000000..0d1cb77260 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicebinding-1.html @@ -0,0 +1,237 @@ + + + + + + ServiceBinding | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServiceBinding

+
+
+
+
+
+
+
+
+
+

Represents the JSON object for a given service binding as obtained from the VCAP_SERVICE environment variable. + To see service bindings, run cf env <app-name> in the terminal. This will produce output like this:

+
+ 
{
+...
+  "VCAP_SERVICES": {
+    "s4-hana-cloud": [
+      {
+        "name": "...",
+        "type": "...".
+        ...
+      }
+    ]
+  }
+}
+

In this example, the key "s4-hana-cloud" refers to an array of service bindings.

+
+
+
+

Hierarchy

+
    +
  • + ServiceBinding +
    • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Represents the JSON object for a given service binding as obtained from the VCAP_SERVICE environment variable. + To see service bindings, run cf env <app-name> in the terminal. This will produce output like this:

+
+ 
{
+...
+  "VCAP_SERVICES": {
+    "s4-hana-cloud": [
+      {
+        "name": "...",
+        "type": "...".
+        ...
+      }
+    ]
+  }
+}
+

In this example, the key "s4-hana-cloud" refers to an array of service bindings.

+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

name

+
name: string
+ +
+
+ +

type

+
type: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicecredentials-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicecredentials-1.html new file mode 100644 index 0000000000..7541f9b124 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.servicecredentials-1.html @@ -0,0 +1,209 @@ + + + + + + ServiceCredentials | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServiceCredentials

+
+
+
+
+
+
+
+
+
+

Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

+
+
+
+
+

Hierarchy

+
    +
  • + ServiceCredentials +
    • +
+
+
+

Indexable

+
[other: string]: any
+
+
+

Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

clientid

+
clientid: string
+ +
+
+ +

clientsecret

+
clientsecret: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tenant.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tenant.html new file mode 100644 index 0000000000..ca7af4706c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tenant.html @@ -0,0 +1,200 @@ + + + + + + Tenant | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface Tenant

+
+
+
+
+
+
+
+
+
+

Representation of the tenant. A tenant represents the customer account on cloud foundry.

+
+
+
+
+

Hierarchy

+
    +
  • + Tenant +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

id

+
id: string
+ +
+
+ +

Optional name

+
name: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tokenkey-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tokenkey-1.html new file mode 100644 index 0000000000..ead7d5ba9c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.tokenkey-1.html @@ -0,0 +1,306 @@ + + + + + + TokenKey | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface TokenKey

+
+
+
+
+
+
+
+
+
+

Response element returned from the XSUAA service's /token_key endpoint. + Value holds the key that is used for verifying JWTs.

+
+
+
+
+

Hierarchy

+
    +
  • + TokenKey +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

algorithm

+
algorithm: string
+ +
+
+

Encryption algorithm, e.g. RSA256.

+
+
+
+
+ +

keyId

+
keyId: string
+ +
+
+

ID of the key.

+
+
+
+
+ +

keyType

+
keyType: string
+ +
+
+

Key type, e.g. RSA.

+
+
+
+
+ +

publicKeyExponent

+
publicKeyExponent: string
+ +
+
+

RSA key exponent.

+
+
+
+
+ +

publicKeyModulus

+
publicKeyModulus: string
+ +
+
+

RSA key modulus.

+
+
+
+
+ +

use

+
use: string
+ +
+
+

Public key use parameter - identifies intended use of the public key.

+
+
+
+
+ +

value

+
value: string
+ +
+
+

The actual key.

+
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.user.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.user.html new file mode 100644 index 0000000000..53047155b5 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.user.html @@ -0,0 +1,310 @@ + + + + + + User | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface User

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

customAttributes

+
customAttributes: Map<string, string[]>
+ +
+
+ +

Optional email

+
email: undefined | string
+ +
+
+ +

Optional familyName

+
familyName: undefined | string
+ +
+
+ +

Optional givenName

+
givenName: undefined | string
+ +
+
+ +

hasScope

+
hasScope: (scope: Scope) => boolean
+ +
+

Type declaration

+
    +
  • +
      +
    • (scope: Scope): boolean
      • +
    +
      +
    • +

      Parameters

      + +

      Returns boolean

      +
      • +
    +
    • +
+
+
+
+ +

id

+
id: string
+ +
+
+ +

scopes

+
scopes: Scope[]
+ +
+
+ +

userName

+
userName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.userdata.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.userdata.html new file mode 100644 index 0000000000..96b50aaba7 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.userdata.html @@ -0,0 +1,275 @@ + + + + + + UserData | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface UserData

+
+
+
+
+
+
+
+
+
+

Representation of the user i.e. authenticated persona. The authentication is done by the XSUAA.

+
+
+
+
+

Hierarchy

+
    +
  • + UserData + +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

customAttributes

+
customAttributes: Map<string, string[]>
+ +
+
+ +

Optional email

+
email: undefined | string
+ +
+
+ +

Optional familyName

+
familyName: undefined | string
+ +
+
+ +

Optional givenName

+
givenName: undefined | string
+ +
+
+ +

id

+
id: string
+ +
+
+ +

scopes

+
scopes: Scope[]
+ +
+
+ +

userName

+
userName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.verifyjwtoptions-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.verifyjwtoptions-1.html new file mode 100644 index 0000000000..2cb20f0e00 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.verifyjwtoptions-1.html @@ -0,0 +1,186 @@ + + + + + + VerifyJwtOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VerifyJwtOptions

+
+
+
+
+
+
+
+
+
+

Options to control certain aspects of JWT verification behavior.

+
+
+
+
+

Hierarchy

+
    +
  • + VerifyJwtOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional cacheVerificationKeys

+
cacheVerificationKeys: undefined | false | true
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials-1.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials-1.html new file mode 100644 index 0000000000..67367128ef --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials-1.html @@ -0,0 +1,326 @@ + + + + + + XsuaaServiceCredentials | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface XsuaaServiceCredentials

+
+
+
+
+
+
+
+
+
+

Credentials for the XSUAA service.

+
+
+
+
+

Hierarchy

+
    +
  • + XsuaaServiceCredentials +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

clientid

+
clientid: string
+ +
+
+ +

clientsecret

+
clientsecret: string
+ +
+
+ +

identityzone

+
identityzone: string
+ +
+
+ +

identityzoneid

+
identityzoneid: string
+ +
+
+ +

sburl

+
sburl: string
+ +
+
+ +

tenantid

+
tenantid: string
+ +
+
+ +

tenantmode

+
tenantmode: string
+ +
+
+ +

uaadomain

+
uaadomain: string
+ +
+
+ +

url

+
url: string
+ +
+
+ +

verificationkey

+
verificationkey: string
+ +
+
+ +

xsappname

+
xsappname: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.apibusinesshubmetadata.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.apibusinesshubmetadata.html new file mode 100644 index 0000000000..5ef261d076 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.apibusinesshubmetadata.html @@ -0,0 +1,207 @@ + + + + + + ApiBusinessHubMetadata | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ApiBusinessHubMetadata

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ApiBusinessHubMetadata +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional businessDocumentationUrl

+
businessDocumentationUrl: undefined | string
+ +
+
+ +

communicationScenario

+
communicationScenario: string | null
+ +
+
+ +

url

+
url: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.doctype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.doctype.html new file mode 100644 index 0000000000..190dc54b24 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.doctype.html @@ -0,0 +1,198 @@ + + + + + + DocType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface DocType

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+ +

type

+
type: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociation.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociation.html new file mode 100644 index 0000000000..b3a1f1c312 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociation.html @@ -0,0 +1,207 @@ + + + + + + EdmxAssociation | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxAssociation

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxAssociation +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

End

+
End: EdmxAssociationEnd[]
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

sap:content-version

+
sap:content-version: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociationset.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociationset.html new file mode 100644 index 0000000000..2275072a37 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxassociationset.html @@ -0,0 +1,263 @@ + + + + + + EdmxAssociationSet | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxAssociationSet

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxAssociationSet +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Association

+
Association: string
+ +
+
+ +

End

+
End: EdmxAssociationSetEnd[]
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

sap:content-version

+
sap:content-version: string
+ +
+
+ +

sap:creatable

+
sap:creatable: string
+ +
+
+ +

sap:deletable

+
sap:deletable: string
+ +
+
+ +

sap:updatable

+
sap:updatable: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxcomplextype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxcomplextype.html new file mode 100644 index 0000000000..12a8b6b4a3 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxcomplextype.html @@ -0,0 +1,193 @@ + + + + + + EdmxComplexType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxComplexType

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxComplexType +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Name

+
Name: string
+ +
+
+ +

Property

+
Property: EdmxProperty[]
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxdocumented.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxdocumented.html new file mode 100644 index 0000000000..325e94d3ad --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxdocumented.html @@ -0,0 +1,187 @@ + + + + + + EdmxDocumented | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxDocumented

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional Documentation

+
Documentation: undefined | { LongDescription: string; Summary: string }
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentityset.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentityset.html new file mode 100644 index 0000000000..093d861c8f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentityset.html @@ -0,0 +1,263 @@ + + + + + + EdmxEntitySet | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxEntitySet

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxEntitySet +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

EntityType

+
EntityType: string
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

sap:content-version

+
sap:content-version: string
+ +
+
+ +

sap:creatable

+
sap:creatable: string
+ +
+
+ +

sap:deletable

+
sap:deletable: string
+ +
+
+ +

sap:pageable

+
sap:pageable: string
+ +
+
+ +

sap:updatable

+
sap:updatable: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentitytype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentitytype.html new file mode 100644 index 0000000000..0d85d558d5 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxentitytype.html @@ -0,0 +1,249 @@ + + + + + + EdmxEntityType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxEntityType

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxEntityType +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Key

+
Key: EdmxKey
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

NavigationProperty

+
NavigationProperty: EdmxNavigationProperty[]
+ +
+
+ +

Property

+
Property: EdmxProperty[]
+ +
+
+ +

sap:content-version

+
sap:content-version: string
+ +
+
+ +

Optional sap:label

+
sap:label: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxfunctionimport.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxfunctionimport.html new file mode 100644 index 0000000000..0ef04e4b13 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxfunctionimport.html @@ -0,0 +1,249 @@ + + + + + + EdmxFunctionImport | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxFunctionImport

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxFunctionImport +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional EntitySet

+
EntitySet: undefined | string
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

Parameter

+
Parameter: EdmxParameter[]
+ +
+
+ +

ReturnType

+
ReturnType: string
+ +
+
+ +

m:HttpMethod

+
m:HttpMethod: string
+ +
+
+ +

sap:action-for

+
sap:action-for: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxmetadata.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxmetadata.html new file mode 100644 index 0000000000..80f8d7d7f6 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxmetadata.html @@ -0,0 +1,305 @@ + + + + + + EdmxMetadata | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxMetadata

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxMetadata +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

associationSets

+
associationSets: EdmxAssociationSet[]
+ +
+
+ +

associations

+
associations: EdmxAssociation[]
+ +
+
+ +

complexTypes

+
complexTypes: EdmxComplexType[]
+ +
+
+ +

entitySets

+
entitySets: EdmxEntitySet[]
+ +
+
+ +

entityTypes

+
entityTypes: EdmxEntityType[]
+ +
+
+ +

fileName

+
fileName: string
+ +
+
+ +

functionImports

+
functionImports: EdmxFunctionImport[]
+ +
+
+ +

namespace

+
namespace: string
+ +
+
+ +

path

+
path: PathLike
+ +
+
+ +

Optional selfLink

+
selfLink: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxparameter.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxparameter.html new file mode 100644 index 0000000000..87b2823a31 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxparameter.html @@ -0,0 +1,227 @@ + + + + + + EdmxParameter | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxParameter

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional Documentation

+
Documentation: undefined | { LongDescription: string; Summary: string }
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

Nullable

+
Nullable: string
+ +
+
+ +

Type

+
Type: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxproperty.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxproperty.html new file mode 100644 index 0000000000..c26206cdcf --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxproperty.html @@ -0,0 +1,339 @@ + + + + + + EdmxProperty | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxProperty

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional Documentation

+
Documentation: undefined | { LongDescription: string; Summary: string }
+ +
+
+ +

MaxLength

+
MaxLength: string
+ +
+
+ +

Name

+
Name: string
+ +
+
+ +

Nullable

+
Nullable: string
+ +
+
+ +

Type

+
Type: string
+ +
+
+ +

sap:creatable

+
sap:creatable: string
+ +
+
+ +

sap:filterable

+
sap:filterable: string
+ +
+
+ +

sap:label

+
sap:label: string
+ +
+
+ +

Optional sap:quickinfo

+
sap:quickinfo: undefined | string
+ +
+
+ +

sap:sortable

+
sap:sortable: string
+ +
+
+ +

sap:unicode

+
sap:unicode: string
+ +
+
+ +

sap:updatable

+
sap:updatable: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxpropertyref.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxpropertyref.html new file mode 100644 index 0000000000..970a66a1bf --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.edmxpropertyref.html @@ -0,0 +1,179 @@ + + + + + + EdmxPropertyRef | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface EdmxPropertyRef

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + EdmxPropertyRef +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Name

+
Name: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.nameddoctype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.nameddoctype.html new file mode 100644 index 0000000000..cf74804d71 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.nameddoctype.html @@ -0,0 +1,214 @@ + + + + + + NamedDocType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface NamedDocType

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + DocType +
      +
    • + NamedDocType +
      • +
    +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+ +

name

+
name: string
+ +
+
+ +

type

+
type: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.parsedservicemetadata.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.parsedservicemetadata.html new file mode 100644 index 0000000000..b066e611db --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.parsedservicemetadata.html @@ -0,0 +1,193 @@ + + + + + + ParsedServiceMetadata | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ParsedServiceMetadata

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ParsedServiceMetadata +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

edmx

+
edmx: EdmxMetadata
+ +
+
+ +

Optional swagger

+
swagger: SwaggerMetadata
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicedefinitionpaths.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicedefinitionpaths.html new file mode 100644 index 0000000000..4edeb98804 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicedefinitionpaths.html @@ -0,0 +1,193 @@ + + + + + + ServiceDefinitionPaths | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServiceDefinitionPaths

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ServiceDefinitionPaths +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

edmxPath

+
edmxPath: PathLike
+ +
+
+ +

Optional swaggerPath

+
swaggerPath: PathLike
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicemapping.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicemapping.html new file mode 100644 index 0000000000..e03d7c341a --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.servicemapping.html @@ -0,0 +1,207 @@ + + + + + + ServiceMapping | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface ServiceMapping

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + ServiceMapping +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

directoryName

+
directoryName: string
+ +
+
+ +

npmPackageName

+
npmPackageName: string
+ +
+
+ +

servicePath

+
servicePath: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerdescribed.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerdescribed.html new file mode 100644 index 0000000000..91d9e25d7c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerdescribed.html @@ -0,0 +1,190 @@ + + + + + + SwaggerDescribed | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SwaggerDescribed

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerentity.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerentity.html new file mode 100644 index 0000000000..83319083a2 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerentity.html @@ -0,0 +1,235 @@ + + + + + + SwaggerEntity | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SwaggerEntity

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: undefined | string
+ +
+
+ +

properties

+
properties: {}
+ +
+

Type declaration

+ +
+
+
+ +

title

+
title: string
+ +
+
+ +

Optional type

+
type: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggermetadata.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggermetadata.html new file mode 100644 index 0000000000..6d174fde50 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggermetadata.html @@ -0,0 +1,300 @@ + + + + + + SwaggerMetadata | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SwaggerMetadata

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + SwaggerMetadata +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional basePath

+
basePath: undefined | string
+ +
+
+ +

definitions

+
definitions: {}
+ +
+

Type declaration

+ +
+
+
+ +

Optional externalDocs

+
externalDocs: undefined | { description: string; string: any; url: any }
+ +
+
+ +

info

+
info: {}
+ +
+

Type declaration

+
    +
  • +
    [properties: string]: string
    +
    • +
+
+
+
+ +

paths

+
paths: {}
+ +
+

Type declaration

+
    +
  • +
    [path: string]: {}
    + +
    • +
+
+
+
+ +

swagger

+
swagger: string
+ +
+
+ +

x-sap-ext-overview

+
x-sap-ext-overview: {}
+ +
+

Type declaration

+
    +
  • +
    [key: string]: any
    +
    • +
+
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpath.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpath.html new file mode 100644 index 0000000000..f889dc5aa3 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpath.html @@ -0,0 +1,193 @@ + + + + + + SwaggerPath | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SwaggerPath

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + SwaggerPath +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

parameters

+
parameters: SwaggerPathParameter[]
+ +
+
+ +

summary

+
summary: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpathparameter.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpathparameter.html new file mode 100644 index 0000000000..d371bd2f04 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerpathparameter.html @@ -0,0 +1,227 @@ + + + + + + SwaggerPathParameter | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SwaggerPathParameter

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: undefined | string
+ +
+
+ +

name

+
name: string
+ +
+
+ +

Optional pattern

+
pattern: undefined | string
+ +
+
+ +

required

+
required: boolean
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerproperty.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerproperty.html new file mode 100644 index 0000000000..1f45a8f71c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.swaggerproperty.html @@ -0,0 +1,297 @@ + + + + + + SwaggerProperty | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface SwaggerProperty

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional description

+
description: undefined | string
+ +
+
+ +

Optional example

+
example: undefined | string
+ +
+
+ +

Optional format

+
format: undefined | string
+ +
+
+ +

Optional maxLength

+
maxLength: undefined | number
+ +
+
+ +

Optional maximum

+
maximum: undefined | number
+ +
+
+ +

Optional minimum

+
minimum: undefined | number
+ +
+
+ +

Optional multipleOf

+
multipleOf: undefined | number
+ +
+
+ +

Optional title

+
title: undefined | string
+ +
+
+ +

type

+
type: string[]
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmcomplextype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmcomplextype.html new file mode 100644 index 0000000000..8708e161a7 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmcomplextype.html @@ -0,0 +1,235 @@ + + + + + + VdmComplexType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmComplexType

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmComplexType +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

factoryName

+
factoryName: string
+ +
+
+ +

fieldType

+
fieldType: string
+ +
+
+ +

originalName

+
originalName: string
+ +
+
+ +

properties

+
properties: VdmProperty[]
+ +
+
+ +

typeName

+
typeName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmentity.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmentity.html new file mode 100644 index 0000000000..e7330b695f --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmentity.html @@ -0,0 +1,305 @@ + + + + + + VdmEntity | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmEntity

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmEntity +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

className

+
className: string
+ +
+
+ +

creatable

+
creatable: boolean
+ +
+
+ +

deletable

+
deletable: boolean
+ +
+
+ +

description

+
description: string
+ +
+
+ +

entitySetName

+
entitySetName: string
+ +
+
+ +

entityTypeName

+
entityTypeName: string
+ +
+
+ +

keys

+
keys: VdmProperty[]
+ +
+
+ +

navigationProperties

+
navigationProperties: VdmNavigationProperty[]
+ +
+
+ +

properties

+
properties: VdmProperty[]
+ +
+
+ +

updatable

+
updatable: boolean
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimport.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimport.html new file mode 100644 index 0000000000..fb97f94656 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimport.html @@ -0,0 +1,263 @@ + + + + + + VdmFunctionImport | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmFunctionImport

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmFunctionImport +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+ +

functionName

+
functionName: string
+ +
+
+ +

httpMethod

+
httpMethod: string
+ +
+
+ +

originalName

+
originalName: string
+ +
+
+ +

parameters

+
parameters: VdmParameter[]
+ +
+
+ +

parametersTypeName

+
parametersTypeName: string
+ +
+
+ +

returnType

+
returnType: VdmFunctionImportReturnType
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimportreturntype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimportreturntype.html new file mode 100644 index 0000000000..7884127a86 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmfunctionimportreturntype.html @@ -0,0 +1,221 @@ + + + + + + VdmFunctionImportReturnType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmFunctionImportReturnType

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmFunctionImportReturnType +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

builderFunction

+
builderFunction: string
+ +
+
+ +

isMulti

+
isMulti: boolean
+ +
+
+ +

returnType

+
returnType: string
+ +
+
+ +

returnTypeCategory

+
returnTypeCategory: VdmFunctionImportReturnTypeCategory
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmappededmtype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmappededmtype.html new file mode 100644 index 0000000000..d89eca757d --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmappededmtype.html @@ -0,0 +1,201 @@ + + + + + + VdmMappedEdmType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmMappedEdmType

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

edmType

+
edmType: string
+ +
+
+ +

jsType

+
jsType: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmapping.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmapping.html new file mode 100644 index 0000000000..a5a7a2aad8 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmmapping.html @@ -0,0 +1,151 @@ + + + + + + VdmMapping | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmMapping

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmMapping +
    • +
+
+
+

Indexable

+
[fileName: string]: ServiceMapping
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmnavigationproperty.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmnavigationproperty.html new file mode 100644 index 0000000000..7a773611e1 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmnavigationproperty.html @@ -0,0 +1,315 @@ + + + + + + VdmNavigationProperty | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmNavigationProperty

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

from

+
from: string
+ +
+
+ +

instancePropertyName

+
instancePropertyName: string
+ +
+
+ +

Optional isComplex

+
isComplex: undefined | false | true
+ +
+
+ +

Optional isMultiLink

+
isMultiLink: undefined | false | true
+ +
+
+ +

multiplicity

+
multiplicity: string
+ +
+
+ +

originalName

+
originalName: string
+ +
+
+ +

propertyNameAsParam

+
propertyNameAsParam: string
+ +
+
+ +

staticPropertyName

+
staticPropertyName: string
+ +
+
+ +

to

+
to: string
+ +
+
+ +

toEntityClassName

+
toEntityClassName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmparameter.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmparameter.html new file mode 100644 index 0000000000..787af34360 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmparameter.html @@ -0,0 +1,256 @@ + + + + + + VdmParameter | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmParameter

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+ +

edmType

+
edmType: string
+ +
+
+ +

jsType

+
jsType: string
+ +
+
+ +

nullable

+
nullable: boolean
+ +
+
+ +

originalName

+
originalName: string
+ +
+
+ +

parameterName

+
parameterName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmproperty.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmproperty.html new file mode 100644 index 0000000000..e540ea90fa --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmproperty.html @@ -0,0 +1,339 @@ + + + + + + VdmProperty | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmProperty

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

description

+
description: string
+ +
+
+ +

edmType

+
edmType: string
+ +
+
+ +

fieldType

+
fieldType: string
+ +
+
+ +

instancePropertyName

+
instancePropertyName: string
+ +
+
+ +

Optional isComplex

+
isComplex: undefined | false | true
+ +
+
+ +

jsType

+
jsType: string
+ +
+
+ +

Optional maxLength

+
maxLength: undefined | string
+ +
+
+ +

nullable

+
nullable: boolean
+ +
+
+ +

originalName

+
originalName: string
+ +
+
+ +

propertyNameAsParam

+
propertyNameAsParam: string
+ +
+
+ +

staticPropertyName

+
staticPropertyName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertydescriptor.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertydescriptor.html new file mode 100644 index 0000000000..6a8812fd7d --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertydescriptor.html @@ -0,0 +1,243 @@ + + + + + + VdmPropertyDescriptor | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmPropertyDescriptor

+
+
+
+
+
+
+
+

Hierarchy

+ +
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

instancePropertyName

+
instancePropertyName: string
+ +
+
+ +

Optional isComplex

+
isComplex: undefined | false | true
+ +
+
+ +

originalName

+
originalName: string
+ +
+
+ +

propertyNameAsParam

+
propertyNameAsParam: string
+ +
+
+ +

staticPropertyName

+
staticPropertyName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertyvalueconstraints.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertyvalueconstraints.html new file mode 100644 index 0000000000..c5bcce6ee5 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmpropertyvalueconstraints.html @@ -0,0 +1,198 @@ + + + + + + VdmPropertyValueConstraints | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmPropertyValueConstraints

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmPropertyValueConstraints + +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional maxLength

+
maxLength: undefined | string
+ +
+
+ +

nullable

+
nullable: boolean
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmservicemetadata.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmservicemetadata.html new file mode 100644 index 0000000000..abb8238b9d --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_generator.vdmservicemetadata.html @@ -0,0 +1,333 @@ + + + + + + VdmServiceMetadata | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface VdmServiceMetadata

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + VdmServiceMetadata +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional apiBusinessHubMetadata

+
apiBusinessHubMetadata: ApiBusinessHubMetadata | undefined
+ +
+
+ +

className

+
className: string
+ +
+
+ +

complexTypes

+
complexTypes: VdmComplexType[]
+ +
+
+ +

directoryName

+
directoryName: string
+ +
+
+ +

edmxPath

+
edmxPath: PathLike
+ +
+
+ +

entities

+
entities: VdmEntity[]
+ +
+
+ +

functionImports

+
functionImports: VdmFunctionImport[]
+ +
+
+ +

namespace

+
namespace: string
+ +
+
+ +

npmPackageName

+
npmPackageName: string
+ +
+
+ +

originalFileName

+
originalFileName: string
+ +
+
+ +

servicePath

+
servicePath: string
+ +
+
+ +

speakingModuleName

+
speakingModuleName: string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html new file mode 100644 index 0000000000..973197b821 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html @@ -0,0 +1,214 @@ + + + + + + GetTestDestinationOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface GetTestDestinationOptions

+
+
+
+
+
+
+
+

Hierarchy

+
    +
  • + GetTestDestinationOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional credentialsFilePath

+
credentialsFilePath: undefined | string
+ +
+
+ +

Optional systemsFilePath

+
systemsFilePath: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.loggeroptions.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.loggeroptions.html new file mode 100644 index 0000000000..9daac15447 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.loggeroptions.html @@ -0,0 +1,275 @@ + + + + + + LoggerOptions | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface LoggerOptions

+
+
+
+
+
+
+
+
+
+

Configurable logger options.

+
+
+
+
+

Hierarchy

+
    +
  • + LoggerOptions +
    • +
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional level

+
level: LogLevel
+ +
+
+ +

Optional logger

+
logger: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.maptype.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.maptype.html new file mode 100644 index 0000000000..6ea26db93c --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.maptype.html @@ -0,0 +1,234 @@ + + + + + + MapType | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface MapType<T>

+
+
+
+
+
+
+
+

Type parameters

+
    +
  • +

    T

    +
    • +
+
+
+

Hierarchy

+
    +
  • + MapType +
    • +
+
+
+

Indexable

+
[key: string]: T
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.messagecontextobj.html b/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.messagecontextobj.html new file mode 100644 index 0000000000..b73c256289 --- /dev/null +++ b/docs/api/1.21.0/interfaces/sap_cloud_sdk_util.messagecontextobj.html @@ -0,0 +1,270 @@ + + + + + + MessageContextObj | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Interface MessageContextObj

+
+
+
+
+
+
+
+
+
+

Log message context for a logger with additional custom data.

+
+
+
+
+

Hierarchy

+
    +
  • + MessageContextObj +
    • +
+
+
+

Indexable

+
[key: string]: any
+
+
+

Log message context for a logger with additional custom data.

+
+
+
+
+

Index

+
+
+
+

Properties

+ +
+
+
+
+
+

Properties

+
+ +

Optional messageContext

+
messageContext: undefined | string
+ +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
  • Property
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/modules/sap_cloud_sdk_analytics.html b/docs/api/1.21.0/modules/sap_cloud_sdk_analytics.html new file mode 100644 index 0000000000..e45ef5d538 --- /dev/null +++ b/docs/api/1.21.0/modules/sap_cloud_sdk_analytics.html @@ -0,0 +1,193 @@ + + + + + + @sap-cloud-sdk/analytics | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @sap-cloud-sdk/analytics

+
+
+
+
+
+
+
+
+ +

cloud-sdk-analytics

+ +

This package contains the code we use for collecting usage data. + Please note that usage analytics is disabled by default, i.e. you need to explicitly opt-in for data to be collected. + For more information on how to opt-in and which data is collected, please refer to this document.

+
+
+
+

Index

+
+
+
+

Interfaces

+ +
+
+

Functions

+ +
+
+
+
+
+

Functions

+
+ +

getProjectIdentifier

+
    +
  • getProjectIdentifier(config: UsageAnalyticsProjectConfig, packageJson: PackageJson): string
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      config: UsageAnalyticsProjectConfig
      +
      • +
    • +
      packageJson: PackageJson
      +
      • +
    +

    Returns string

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/modules/sap_cloud_sdk_core.html b/docs/api/1.21.0/modules/sap_cloud_sdk_core.html new file mode 100644 index 0000000000..98dab107ff --- /dev/null +++ b/docs/api/1.21.0/modules/sap_cloud_sdk_core.html @@ -0,0 +1,8890 @@ + + + + + + @sap-cloud-sdk/core | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @sap-cloud-sdk/core

+
+
+
+
+
+
+
+
+

SAP Cloud SDK for JavaScript Logo

+ +

@sap-cloud-sdk/core

+ +

This package contains the core functionality of the SAP Cloud SDK as well as the Cloud Platform abstractions.

+ +

Installation

+ + 
$ npm install @sap-cloud-sdk/core
+ +

Usage

+ +

The core is the heart of the SAP Cloud SDK and contains the functionality that is essential to every project powered by the SDK. Any OData client built by the SAP Cloud SDK, be it the VDM or clients built by the generator are using the core. We recommend to install this in addition to your clients.

+

Below is an example showing how you can build and execute your request with multiple filters by using an function called and.

+ 
import { and } from '@sap-cloud-sdk/core';
+import { BusinessPartner } from '@sap/cloud-sdk-vdm-business-partner-service';
+
+// Build your filters
+const firstNameFilter = BusinessPartner.FIRST_NAME.equals('firstName');
+const lastNameFilter = BusinessPartner.LAST_NAME.equals('lastName');
+
+// Execute your request with two filters
+BusinessPartner.requestBuilder()
+ .getAll()
+ .filter(and(firstNameFilter, lastNameFilter))
+ .execute(yourDestination);
+ +

Api documentation

+ +

https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts

+ +

Helpful Links

+ + +
+
+
+

Index

+
+
+
+

References

+ +
+
+

Enumerations

+ +
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Type aliases

+ +
+
+

Variables

+ +
+
+

Functions

+ +
+
+

Object literals

+ +
+
+
+
+
+

References

+
+ +

AllFields

+ Re-exports AllFields +
+
+ +

AuthenticationType

+ Re-exports AuthenticationType +
+
+ +

BatchResponse

+ Re-exports BatchResponse +
+
+ +

BigNumberField

+ Re-exports BigNumberField +
+
+ +

BinaryField

+ Re-exports BinaryField +
+
+ +

BinaryFieldBase

+ Re-exports BinaryFieldBase +
+
+ +

BooleanField

+ Re-exports BooleanField +
+
+ +

BooleanFieldBase

+ Re-exports BooleanFieldBase +
+
+ +

BooleanFilterFunction

+ Re-exports BooleanFilterFunction +
+
+ +

Cache

+ Re-exports Cache +
+
+ +

CachingOptions

+ Re-exports CachingOptions +
+
+ +

ClientCredentials

+ Re-exports ClientCredentials +
+
+ +

CompleteDecodedJWT

+ Re-exports CompleteDecodedJWT +
+
+ +

ComplexTypeBigNumberPropertyField

+ Re-exports ComplexTypeBigNumberPropertyField +
+
+ +

ComplexTypeBinaryPropertyField

+ Re-exports ComplexTypeBinaryPropertyField +
+
+ +

ComplexTypeBooleanPropertyField

+ Re-exports ComplexTypeBooleanPropertyField +
+
+ +

ComplexTypeDatePropertyField

+ Re-exports ComplexTypeDatePropertyField +
+
+ +

ComplexTypeField

+ Re-exports ComplexTypeField +
+
+ +

ComplexTypeNumberPropertyField

+ Re-exports ComplexTypeNumberPropertyField +
+
+ +

ComplexTypePropertyFields

+ Re-exports ComplexTypePropertyFields +
+
+ +

ComplexTypeStringPropertyField

+ Re-exports ComplexTypeStringPropertyField +
+
+ +

ComplexTypeTimePropertyField

+ Re-exports ComplexTypeTimePropertyField +
+
+ +

Constructable

+ Re-exports Constructable +
+
+ +

ConstructorOrField

+ Re-exports ConstructorOrField +
+
+ +

CreateRequestBuilder

+ Re-exports CreateRequestBuilder +
+
+ +

CustomField

+ Re-exports CustomField +
+
+ +

CustomFieldBase

+ Re-exports CustomFieldBase +
+
+ +

DateField

+ Re-exports DateField +
+
+ +

DateFieldBase

+ Re-exports DateFieldBase +
+
+ +

DecodedJWT

+ Re-exports DecodedJWT +
+
+ +

DeepFieldType

+ Re-exports DeepFieldType +
+
+ +

DeleteRequestBuilder

+ Re-exports DeleteRequestBuilder +
+
+ +

Destination

+ Re-exports Destination +
+
+ +

DestinationAccessorOptions

+ Re-exports DestinationAccessorOptions +
+
+ +

DestinationAuthToken

+ Re-exports DestinationAuthToken +
+
+ +

DestinationCachingOptions

+ Re-exports DestinationCachingOptions +
+
+ +

DestinationCertificate

+ Re-exports DestinationCertificate +
+
+ +

DestinationConfiguration

+ Re-exports DestinationConfiguration +
+
+ +

DestinationForServiceBindingsOptions

+ Re-exports DestinationForServiceBindingsOptions +
+
+ +

DestinationHttpRequestConfig

+ Re-exports DestinationHttpRequestConfig +
+
+ +

DestinationJson

+ Re-exports DestinationJson +
+
+ +

DestinationNameAndJwt

+ Re-exports DestinationNameAndJwt +
+
+ +

DestinationOptions

+ Re-exports DestinationOptions +
+
+ +

DestinationOrigin

+ Re-exports DestinationOrigin +
+
+ +

DestinationProxyType

+ Re-exports DestinationProxyType +
+
+ +

DestinationRetrievalOptions

+ Re-exports DestinationRetrievalOptions +
+
+ +

DestinationSelectionStrategies

+ Re-exports DestinationSelectionStrategies +
+
+ +

DestinationSelectionStrategy

+ Re-exports DestinationSelectionStrategy +
+
+ +

DestinationServiceCredentials

+ Re-exports DestinationServiceCredentials +
+
+ +

EdmToPrimitive

+ Re-exports EdmToPrimitive +
+
+ +

EdmType

+ Re-exports EdmType +
+
+ +

EdmTypeCommon

+ Re-exports EdmTypeCommon +
+
+ +

EdmTypeDifferentConverters

+ Re-exports EdmTypeDifferentConverters +
+
+ +

EdmTypeField

+ Re-exports EdmTypeField +
+
+ +

EdmTypeSameConverters

+ Re-exports EdmTypeSameConverters +
+
+ +

EdmTypeSameConvertersUri

+ Re-exports EdmTypeSameConvertersUri +
+
+ +

EdmTypeShared

+ Re-exports EdmTypeShared +
+
+ +

EdmTypeV2

+ Re-exports EdmTypeV2 +
+
+ +

EdmTypeV4

+ Re-exports EdmTypeV4 +
+
+ +

Entity

+ Re-exports Entity +
+
+ +

EntityBase

+ Re-exports EntityBase +
+
+ +

EntityBuilder

+ Re-exports EntityBuilder +
+
+ +

EntityBuilderType

+ Re-exports EntityBuilderType +
+
+ +

EntityIdentifiable

+ Re-exports EntityIdentifiable +
+
+ +

EnvironmentAccessor

+ Re-exports EnvironmentAccessor +
+
+ +

ErrorResponse

+ Re-exports ErrorResponse +
+
+ +

ExecuteHttpRequestFn

+ Re-exports ExecuteHttpRequestFn +
+
+ +

Field

+ Re-exports Field +
+
+ +

FieldType

+ Re-exports FieldType +
+
+ +

Filter

+ Re-exports Filter +
+
+ +

FilterFunction

+ Re-exports FilterFunction +
+
+ +

FilterFunctionParameterType

+ Re-exports FilterFunctionParameterType +
+
+ +

FilterLink

+ Re-exports FilterLink +
+
+ +

FilterList

+ Re-exports FilterList +
+
+ +

FilterOperator

+ Re-exports FilterOperator +
+
+ +

FilterOperatorByType

+ Re-exports FilterOperatorByType +
+
+ +

Filterable

+ Re-exports Filterable +
+
+ +

FunctionImportParameter

+ Re-exports FunctionImportParameter +
+
+ +

FunctionImportParameters

+ Re-exports FunctionImportParameters +
+
+ +

FunctionImportRequestBuilder

+ Re-exports FunctionImportRequestBuilder +
+
+ +

GetAllRequestBuilder

+ Re-exports GetAllRequestBuilder +
+
+ +

GetByKeyRequestBuilder

+ Re-exports GetByKeyRequestBuilder +
+
+ +

HttpAgentConfig

+ Re-exports HttpAgentConfig +
+
+ +

HttpMethod

+ Re-exports HttpMethod +
+
+ +

HttpReponse

+ Re-exports HttpReponse +
+
+ +

HttpRequest

+ Re-exports HttpRequest +
+
+ +

HttpRequestConfig

+ Re-exports HttpRequestConfig +
+
+ +

HttpResponse

+ Re-exports HttpResponse +
+
+ +

HttpsAgentConfig

+ Re-exports HttpsAgentConfig +
+
+ +

IsolationStrategy

+ Re-exports IsolationStrategy +
+
+ +

JWTHeader

+ Re-exports JWTHeader +
+
+ +

JWTPayload

+ Re-exports JWTPayload +
+
+ +

JwtKeyMapping

+ Re-exports JwtKeyMapping +
+
+ +

Link

+ Re-exports Link +
+
+ +

MethodRequestBuilderBase

+ Re-exports MethodRequestBuilderBase +
+
+ +

NumberField

+ Re-exports NumberField +
+
+ +

NumberFieldBase

+ Re-exports NumberFieldBase +
+
+ +

NumberFilterFunction

+ Re-exports NumberFilterFunction +
+
+ +

ODataBatchChangeSet

+ Re-exports ODataBatchChangeSet +
+
+ +

ODataBatchRequestBuilder

+ Re-exports ODataBatchRequestBuilder +
+
+ +

ODataRequest

+ Re-exports ODataRequest +
+
+ +

ODataRequestConfig

+ Re-exports ODataRequestConfig +
+
+ +

ODataUri

+ Re-exports ODataUri +
+
+ +

ODataVersion

+ Re-exports ODataVersion +
+
+ +

OneToManyLink

+ Re-exports OneToManyLink +
+
+ +

OneToOneLink

+ Re-exports OneToOneLink +
+
+ +

Order

+ Re-exports Order +
+
+ +

OrderLink

+ Re-exports OrderLink +
+
+ +

Orderable

+ Re-exports Orderable +
+
+ +

OrderableInput

+ Re-exports OrderableInput +
+
+ +

Protocol

+ Re-exports Protocol +
+
+ +

ProxyConfiguration

+ Re-exports ProxyConfiguration +
+
+ +

ProxyStrategy

+ Re-exports ProxyStrategy +
+
+ +

ReadResponse

+ Re-exports ReadResponse +
+
+ +

RegisteredJWTClaims

+ Re-exports RegisteredJWTClaims +
+
+ +

RegisteredJWTClaimsBasic

+ Re-exports RegisteredJWTClaimsBasic +
+
+ +

RequestBuilder

+ Re-exports RequestBuilder +
+
+ +

RequestMethodType

+ Re-exports RequestMethodType +
+
+ +

ResilienceOptions

+ Re-exports ResilienceOptions +
+
+ +

Selectable

+ Re-exports Selectable +
+
+ +

SelectableEdmTypeField

+ Re-exports SelectableEdmTypeField +
+
+ +

Service

+ Re-exports Service +
+
+ +

ServiceBinding

+ Re-exports ServiceBinding +
+
+ +

ServiceCredentials

+ Re-exports ServiceCredentials +
+
+ +

SimpleTypeFields

+ Re-exports SimpleTypeFields +
+
+ +

StringField

+ Re-exports StringField +
+
+ +

StringFilterFunction

+ Re-exports StringFilterFunction +
+
+ +

Time

+ Re-exports Time +
+
+ +

TimeField

+ Re-exports TimeField +
+
+ +

TimeFieldBase

+ Re-exports TimeFieldBase +
+
+ +

TimeFractionalSeconds

+ Re-exports TimeFractionalSeconds +
+
+ +

TokenKey

+ Re-exports TokenKey +
+
+ +

UpdateRequestBuilder

+ Re-exports UpdateRequestBuilder +
+
+ +

UriConverter

+ Re-exports UriConverter +
+
+ +

VerifyJwtOptions

+ Re-exports VerifyJwtOptions +
+
+ +

WithETag

+ Re-exports WithETag +
+
+ +

WithGetAllRestrictions

+ Re-exports WithGetAllRestrictions +
+
+ +

WithKeys

+ Re-exports WithKeys +
+
+ +

WithSelection

+ Re-exports WithSelection +
+
+ +

WriteResponse

+ Re-exports WriteResponse +
+
+ +

WriteResponses

+ Re-exports WriteResponses +
+
+ +

XsuaaServiceCredentials

+ Re-exports XsuaaServiceCredentials +
+
+ +

addAuthorizationHeader

+ Re-exports addAuthorizationHeader +
+
+ +

addCsrfTokenAndCookies

+ Re-exports addCsrfTokenAndCookies +
+
+ +

addDestinationToRequestConfig

+ Re-exports addDestinationToRequestConfig +
+
+ +

addProxyConfiguration

+ Re-exports addProxyConfiguration +
+
+ +

addProxyConfigurationInternet

+ Re-exports addProxyConfigurationInternet +
+
+ +

addProxyConfigurationOnPrem

+ Re-exports addProxyConfigurationOnPrem +
+
+ +

alwaysProvider

+ Re-exports alwaysProvider +
+
+ +

alwaysSubscriber

+ Re-exports alwaysSubscriber +
+
+ +

and

+ Re-exports and +
+
+ +

asc

+ Re-exports asc +
+
+ +

audiences

+ Re-exports audiences +
+
+ +

basicHeader

+ Re-exports basicHeader +
+
+ +

buildAndAddAuthorizationHeader

+ Re-exports buildAndAddAuthorizationHeader +
+
+ +

buildAuthorizationHeaders

+ Re-exports buildAuthorizationHeaders +
+
+ +

buildCsrfHeaders

+ Re-exports buildCsrfHeaders +
+
+ +

buildHeaders

+ Re-exports buildHeaders +
+
+ +

buildHeadersForDestination

+ Re-exports buildHeadersForDestination +
+
+ +

buildHttpRequest

+ Re-exports buildHttpRequest +
+
+ +

checkMandatoryValue

+ Re-exports checkMandatoryValue +
+
+ +

circuitBreakerDefaultOptions

+ Re-exports circuitBreakerDefaultOptions +
+
+ +

clientCredentialsGrant

+ Re-exports clientCredentialsGrant +
+
+ +

clientCredentialsTokenCache

+ Re-exports clientCredentialsTokenCache +
+
+ +

content_transfer_encoding_line

+ Re-exports content_transfer_encoding_line +
+
+ +

convertToUriFormat

+ Re-exports convertToUriFormat +
+
+ +

createComplexType

+ Re-exports createComplexType +
+
+ +

createGetFilter

+ Re-exports createGetFilter +
+
+ +

createGetResourcePathForKeys

+ Re-exports createGetResourcePathForKeys +
+
+ +

customAttributes

+ Re-exports customAttributes +
+
+ +

decodeJwt

+ Re-exports decodeJwt +
+
+ +

decodeJwtComplete

+ Re-exports decodeJwtComplete +
+
+ +

desc

+ Re-exports desc +
+
+ +

deserializeEntity

+ Re-exports deserializeEntity +
+
+ +

destinationCache

+ Re-exports destinationCache +
+
+ +

destinationForServiceBinding

+ Re-exports destinationForServiceBinding +
+
+ +

edmToTs

+ Re-exports edmToTs +
+
+ +

execute

+ Re-exports execute +
+
+ +

executeHttpRequest

+ Re-exports executeHttpRequest +
+
+ +

extractClientCredentials

+ Re-exports extractClientCredentials +
+
+ +

extractCustomFields

+ Re-exports extractCustomFields +
+
+ +

fetchDestination

+ Re-exports fetchDestination +
+
+ +

fetchInstanceDestinations

+ Re-exports fetchInstanceDestinations +
+
+ +

fetchSubaccountDestinations

+ Re-exports fetchSubaccountDestinations +
+
+ +

fetchVerificationKeys

+ Re-exports fetchVerificationKeys +
+
+ +

filterNullishValues

+ Re-exports filterNullishValues +
+
+ +

getAgentConfig

+ Re-exports getAgentConfig +
+
+ +

getAxiosConfigWithDefaults

+ Re-exports getAxiosConfigWithDefaults +
+
+ +

getDestination

+ Re-exports getDestination +
+
+ +

getDestinationBasicCredentials

+ Re-exports getDestinationBasicCredentials +
+
+ +

getDestinationByName

+ Re-exports getDestinationByName +
+
+ +

getDestinationFromDestinationService

+ Re-exports getDestinationFromDestinationService +
+
+ +

getDestinationFromEnvByName

+ Re-exports getDestinationFromEnvByName +
+
+ +

getDestinationOptions

+ Re-exports getDestinationOptions +
+
+ +

getDestinationServiceCredentials

+ Re-exports getDestinationServiceCredentials +
+
+ +

getDestinationServiceCredentialsList

+ Re-exports getDestinationServiceCredentialsList +
+
+ +

getDestinationServiceUri

+ Re-exports getDestinationServiceUri +
+
+ +

getDestinations

+ Re-exports getDestinations +
+
+ +

getDestinationsFromEnv

+ Re-exports getDestinationsFromEnv +
+
+ +

getEdmType

+ Re-exports getEdmType +
+
+ +

getEntityConstructor

+ Re-exports getEntityConstructor +
+
+ +

getEntityKeys

+ Re-exports getEntityKeys +
+
+ +

getEnvironmentVariable

+ Re-exports getEnvironmentVariable +
+
+ +

getExpand

+ Re-exports getExpand +
+
+ +

getFilter

+ Re-exports getFilter +
+
+ +

getGrantTokenCacheKey

+ Re-exports getGrantTokenCacheKey +
+
+ +

getHeader

+ Re-exports getHeader +
+
+ +

getHeaderValue

+ Re-exports getHeaderValue +
+
+ +

getOAuth2ClientCredentialsToken

+ Re-exports getOAuth2ClientCredentialsToken +
+
+ +

getOrderBy

+ Re-exports getOrderBy +
+
+ +

getProtocolOrDefault

+ Re-exports getProtocolOrDefault +
+
+ +

getRequestLine

+ Re-exports getRequestLine +
+
+ +

getSelect

+ Re-exports getSelect +
+
+ +

getService

+ Re-exports getService +
+
+ +

getServiceCredentialsList

+ Re-exports getServiceCredentialsList +
+
+ +

getServiceList

+ Re-exports getServiceList +
+
+ +

getUrlProtocol

+ Re-exports getUrlProtocol +
+
+ +

getVcapService

+ Re-exports getVcapService +
+
+ +

getXsuaaServiceCredentials

+ Re-exports getXsuaaServiceCredentials +
+
+ +

headerForClientCredentials

+ Re-exports headerForClientCredentials +
+
+ +

http_version

+ Re-exports http_version +
+
+ +

isDestination

+ Re-exports isDestination +
+
+ +

isDestinationNameAndJwt

+ Re-exports isDestinationNameAndJwt +
+
+ +

isExistentProperty

+ Re-exports isExistentProperty +
+
+ +

isExpandedProperty

+ Re-exports isExpandedProperty +
+
+ +

isFilter

+ Re-exports isFilter +
+
+ +

isFilterLink

+ Re-exports isFilterLink +
+
+ +

isFilterList

+ Re-exports isFilterList +
+
+ +

isIdenticalTenant

+ Re-exports isIdenticalTenant +
+
+ +

isSelectedProperty

+ Re-exports isSelectedProperty +
+
+ +

isWithETag

+ Re-exports isWithETag +
+
+ +

issuerUrl

+ Re-exports issuerUrl +
+
+ +

nonEnumerable

+ Re-exports nonEnumerable +
+
+ +

oDataUri

+ Re-exports oDataUri +
+
+ +

or

+ Re-exports or +
+
+ +

parseDestination

+ Re-exports parseDestination +
+
+ +

parseProxyEnv

+ Re-exports parseProxyEnv +
+
+ +

part_content_type_line

+ Re-exports part_content_type_line +
+
+ +

prependDollar

+ Re-exports prependDollar +
+
+ +

proxyAgent

+ Re-exports proxyAgent +
+
+ +

proxyStrategy

+ Re-exports proxyStrategy +
+
+ +

refreshTokenGrant

+ Re-exports refreshTokenGrant +
+
+ +

replaceDuplicateKeys

+ Re-exports replaceDuplicateKeys +
+
+ +

resolveService

+ Re-exports resolveService +
+
+ +

retrieveJwt

+ Re-exports retrieveJwt +
+
+ +

sanitizeDestination

+ Re-exports sanitizeDestination +
+
+ +

secondsToTime

+ Re-exports secondsToTime +
+
+ +

serializeEntity

+ Re-exports serializeEntity +
+
+ +

serializeEntityNonCustomFields

+ Re-exports serializeEntityNonCustomFields +
+
+ +

serviceToken

+ Re-exports serviceToken +
+
+ +

subscriberFirst

+ Re-exports subscriberFirst +
+
+ +

tenantId

+ Re-exports tenantId +
+
+ +

tenantName

+ Re-exports tenantName +
+
+ +

timeToSeconds

+ Re-exports timeToSeconds +
+
+ +

toBatchChangeSet

+ Re-exports toBatchChangeSet +
+
+ +

toBatchRetrieveBody

+ Re-exports toBatchRetrieveBody +
+
+ +

toPascalCase

+ Re-exports toPascalCase +
+
+ +

toPropertyFormat

+ Re-exports toPropertyFormat +
+
+ +

toSanitizedHeaderObject

+ Re-exports toSanitizedHeaderObject +
+
+ +

toStaticPropertyFormat

+ Re-exports toStaticPropertyFormat +
+
+ +

toTitleFormat

+ Re-exports toTitleFormat +
+
+ +

toTypeNameFormat

+ Re-exports toTypeNameFormat +
+
+ +

transformReturnValueForComplexType

+ Re-exports transformReturnValueForComplexType +
+
+ +

transformReturnValueForComplexTypeList

+ Re-exports transformReturnValueForComplexTypeList +
+
+ +

transformReturnValueForEdmType

+ Re-exports transformReturnValueForEdmType +
+
+ +

transformReturnValueForEdmTypeList

+ Re-exports transformReturnValueForEdmTypeList +
+
+ +

transformReturnValueForEntity

+ Re-exports transformReturnValueForEntity +
+
+ +

transformReturnValueForEntityList

+ Re-exports transformReturnValueForEntityList +
+
+ +

transformReturnValueForUndefined

+ Re-exports transformReturnValueForUndefined +
+
+ +

tsToEdm

+ Re-exports tsToEdm +
+
+ +

uriConverters

+ Re-exports uriConverters +
+
+ +

useOrFetchDestination

+ Re-exports useOrFetchDestination +
+
+ +

userApprovedServiceToken

+ Re-exports userApprovedServiceToken +
+
+ +

userEmail

+ Re-exports userEmail +
+
+ +

userFamilyName

+ Re-exports userFamilyName +
+
+ +

userGivenName

+ Re-exports userGivenName +
+
+ +

userId

+ Re-exports userId +
+
+ +

userName

+ Re-exports userName +
+
+ +

userScopes

+ Re-exports userScopes +
+
+ +

userTokenGrant

+ Re-exports userTokenGrant +
+
+ +

verificationKeyCache

+ Re-exports verificationKeyCache +
+
+ +

verifyJwt

+ Re-exports verifyJwt +
+
+ +

verifyJwtWithKey

+ Re-exports verifyJwtWithKey +
+
+ +

wrapJwtInHeader

+ Re-exports wrapJwtInHeader +
+
+
+

Type aliases

+
+ +

AuthenticationType

+
AuthenticationType: "PrincipalPropagation" | "NoAuthentication" | "BasicAuthentication" | "OAuth2SAMLBearerAssertion" | "OAuth2ClientCredentials" | "ClientCertificateAuthentication"
+ +
+
+ +

DestinationOptions

+
DestinationOptions: DestinationAccessorOptions & DestinationRetrievalOptions & VerifyJwtOptions
+ +
+
+ +

DestinationProxyType

+
DestinationProxyType: "OnPremise" | "Internet" | null
+ +
+
+ +

DestinationRetrievalOptions

+
DestinationRetrievalOptions: DestinationCachingOptions | CachingOptions & ResilienceOptions
+ +
+
+

Options to use while fetching destinations. Encompasses both DestinationCachingOptions and ResilienceOptions interfaces.

+
+
+
+
+ +

DestinationSelectionStrategy

+
DestinationSelectionStrategy: (allDestinations: AllDestinations, destinationName: string) => Destination | null
+ +
+

Type declaration

+
    +
  • +
      +
    • (allDestinations: AllDestinations, destinationName: string): Destination | null
      • +
    +
      +
    • +

      Parameters

      +
        +
      • +
        allDestinations: AllDestinations
        +
        • +
      • +
        destinationName: string
        +
        • +
      +

      Returns Destination | null

      +
      • +
    +
    • +
+
+
+
+ +

EdmToPrimitive

+
EdmToPrimitive<T>: T extends "Edm.Int16" | "Edm.Int32" | "Edm.Single" | "Edm.Double" | "Edm.Float" | "Edm.Byte" | "Edm.SByte" ? number : T extends "Edm.Decimal" | "Edm.Int64" ? BigNumber : T extends "Edm.DateTime" | "Edm.DateTimeOffset" ? Moment : T extends "Edm.String" | "Edm.Guid" ? string : T extends "Edm.Boolean" ? boolean : T extends "Edm.Time" ? Time : any
+ +

Type parameters

+ +
+
+ +

EdmType

+
EdmType: EdmTypeCommon | EdmTypeV2
+ +
+
+ +

ExecuteHttpRequestFn

+
ExecuteHttpRequestFn: (request: HttpRequest) => Promise<HttpResponse>
+ +
+

Type declaration

+ +
+
+
+ +

HttpRequest

+
HttpRequest: DestinationHttpRequestConfig & HttpRequestConfig
+ +
+
+ +

JwtKeyMapping

+
JwtKeyMapping<TypescriptKeys, JwtKeys>: {}
+ +

Type parameters

+
    +
  • +

    TypescriptKeys

    +
    • +
  • +

    JwtKeys

    +
    • +
+
+

Type declaration

+
    +
+
+
+
+ +

RegisteredJWTClaims

+
RegisteredJWTClaims: RegisteredJWTClaimsBasic & RegisteredJWTClaimsUser & RegisteredJWTClaimsTenant
+ +
+
+

Interface to represent the registered claims of a JWT.

+
+
+
+
+
+

Variables

+
+ +

Const clientCredentialsTokenCache

+
clientCredentialsTokenCache: { cacheRetrievedToken: any; clear: any; getCacheInstance: any; getGrantTokenFromCache: any } = ClientCredentialsTokenCache(new Cache<ClientCredentialsResponse>())
+ +
+

Type declaration

+ +
+
+
+ +

Const deserializeEntity

+
deserializeEntity: deserializeEntity = deserializer.deserializeEntity
+ +
+
+ +

Const destinationCache

+
destinationCache: { cacheRetrievedDestinations: any; clear: any; getCacheInstance: any; retrieveDestinationFromCache: any } = DestinationCache(new Cache<Destination>({ hours: 0, minutes: 5, seconds: 0 }))
+ +
+

Type declaration

+ +
+
+
+ +

Const executeHttpRequest

+
executeHttpRequest: (Anonymous function) = execute(executeWithAxios)
+ +
+
+

Builds a DestinationHttpRequestConfig for the given destination, merges it into the given requestConfig + and executes it (using Axios).

+
+
+
param
+

A destination or a destination name and a JWT.

+
+
param
+

Any object representing an HTTP request.

+
+
returns
+

An HttpResponse.

+
+
+
+
+
+ +

Const extractCustomFields

+
extractCustomFields: extractCustomFields = deserializer.extractCustomFields
+ +
+
+ +

Const serializeEntity

+
serializeEntity: serializeEntity = serializer.serializeEntity
+ +
+
+ +

Const serializeEntityNonCustomFields

+
serializeEntityNonCustomFields: serializeEntityNonCustomFields = serializer.serializeEntityNonCustomFields
+ +
+
+ +

Const verificationKeyCache

+
verificationKeyCache: Cache<unknown> = new Cache({ minutes: 15 })
+ +
+
+
+

Functions

+
+ +

addAuthorizationHeader

+
    +
  • addAuthorizationHeader<RequestT>(request: ODataRequest<RequestT>, headers: MapType<string>): Promise<MapType<string>>
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.20.0. Use buildAuthorizationHeaders instead. + Adds authorization headers for a given ODataRequest to existing headers.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      RequestT: ODataRequestConfig

      +
      • +
    +

    Parameters

    +
      +
    • +
      request: ODataRequest<RequestT>
      +
      +

      an ODataRequest.

      +
      +
      • +
    • +
      headers: MapType<string>
      +
      +

      The headers that should be added to.

      +
      +
      • +
    +

    Returns Promise<MapType<string>>

    +

    The provided headers with the new authorization headers.

    +
    • +
+
+
+ +

addCsrfTokenAndCookies

+
    +
  • addCsrfTokenAndCookies<RequestT>(request: ODataRequest<RequestT>, headers: MapType<string>): Promise<MapType<string>>
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.20.0, use buildCsrfHeaders instead.

    +

    Add CSRF token and cookies for a request to destination related headers.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      RequestT: ODataRequestConfig

      +
      • +
    +

    Parameters

    +
      +
    • +
      request: ODataRequest<RequestT>
      +
      +

      The request to get CSRF headers for.

      +
      +
      • +
    • +
      headers: MapType<string>
      +
      +

      Destination related headers to include in the request.

      +
      +
      • +
    +

    Returns Promise<MapType<string>>

    +

    A promise to an object containing the CSRF related headers

    +
    • +
+
+
+ +

addDestinationToRequestConfig

+ + +
+
+ +

addProxyConfiguration

+ +
    +
  • + +
    +
    +

    Given a destination and a JWT (required for subscriber destinations), this function will add a proxy configuration to a destination. + See also ProxyConfiguration.

    +
    +

    This function will reject if no connectivity service is bound, no XSUAA service with plan application is bound or the client credentials grant with the XSUAA service fails.

    +
    +
    deprecated
    +

    Since v1.16.0. Use addProxyConfigurationOnPrem instead.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      The destination to which the proxy configuration should be added.

      +
      +
      • +
    • +
      Optional jwt: undefined | string
      +
      +

      The JWT of the current user.

      +
      +
      • +
    +

    Returns Promise<Destination>

    +

    A promise resolving to the destiation with the added proxy configuration.

    +
    • +
+
+
+ +

addProxyConfigurationInternet

+
    +
  • addProxyConfigurationInternet(destination: any): Destination
    • +
+
    +
  • + +
    +
    +

    Adds the proxy configuration to a destination based on web proxies defined in environment variables. See ProxyConfiguration and proxyStrategy for details.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: any
      +
      +

      to which the proxy configuration is added.

      +
      +
      • +
    +

    Returns Destination

    +

    Destination containing the configuration for web proxy.

    +
    • +
+
+
+ +

addProxyConfigurationOnPrem

+ + +
+
+ +

alwaysProvider

+
    +
  • alwaysProvider(allDestinations: AllDestinations, destinationName: string): Destination | null
    • +
+
    +
  • + +
    +
    +

    Constraints the selection to provider destinations.

    +
    +
    +

    Parameters

    +
      +
    • +
      allDestinations: AllDestinations
      +
      +

      Retrieved destinations

      +
      +
      • +
    • +
      destinationName: string
      +
      +

      Name of the destination to retrieve

      +
      +
      • +
    +

    Returns Destination | null

    +

    the destination to retrieve, returns null if no matched provider destination is found

    +
    • +
+
+
+ +

alwaysSubscriber

+
    +
  • alwaysSubscriber(allDestinations: AllDestinations, destinationName: string): Destination | null
    • +
+
    +
  • + +
    +
    +

    Constraints the selection to subscriber destinations.

    +
    +
    +

    Parameters

    +
      +
    • +
      allDestinations: AllDestinations
      +
      +

      Retrieved destinations

      +
      +
      • +
    • +
      destinationName: string
      +
      +

      Name of the destination to retrieve

      +
      +
      • +
    +

    Returns Destination | null

    +

    the destination to retrieve, returns null if no matched subscriber destination is found

    +
    • +
+
+
+ +

audiences

+
    +
  • audiences(decodedToken: DecodedJWT): Set<string>
    • +
+
    +
  • + +
    +
    +

    Retrieve the audiences of a decoded JWT based on the audiences and scopes in the token.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to retrieve the audiences from.

      +
      +
      • +
    +

    Returns Set<string>

    +

    A set of audiences.

    +
    • +
+
+
+ +

basicHeader

+
    +
  • basicHeader(username: string, password: string): string
    • +
+ +
+
+ +

buildAndAddAuthorizationHeader

+
    +
  • buildAndAddAuthorizationHeader(destination: Destination): (Anonymous function)
    • +
+ +
+
+ +

buildAuthorizationHeaders

+
    +
  • buildAuthorizationHeaders(destination: Destination): Promise<MapType<string>>
    • +
+ +
+
+ +

buildCsrfHeaders

+ +
    +
  • + +
    +
    +

    Get CSRF token and cookies for a destination and request configuration. The CSRF token and cookies will be retrieved based on the url of the destination and the custom configuration given by the requestConfig. + If there is a relative url in the requestConfig it will be appended to the destination's url, an absolute url overwrites the destination related url.

    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      destination: Destination | DestinationNameAndJwt
      +
      +

      The destination to get the headers from

      +
      +
      • +
    • +
      requestConfig: Partial<T>
      +
      +

      An http request configuration containing additional information about the request, like url or headers

      +
      +
      • +
    +

    Returns Promise<MapType<string>>

    +

    A promise to an object containing the CSRF related headers

    +
    • +
+
+
+ +

buildHeaders

+
    +
  • buildHeaders<RequestT>(request: ODataRequest<RequestT>): Promise<MapType<string>>
    • +
+
    +
  • + +
    +
    +

    Create object containing all headers, including custom headers for a given OData request configuration and destination. + Custom headers override duplicate headers.

    +
    +
    +

    Type parameters

    +
      +
    • +

      RequestT: ODataRequestConfig

      +
      +

      Type of the request the headers are built for

      +
      +
      • +
    +

    Parameters

    +
      +
    • +
      request: ODataRequest<RequestT>
      +
      +

      OData request configuration to create headers for

      +
      +
      • +
    +

    Returns Promise<MapType<string>>

    +

    Key-value pairs where the key is the name of a header property and the value is the respective value

    +
    • +
+
+
+ +

buildHeadersForDestination

+
    +
  • buildHeadersForDestination(destination: Destination, customHeaders?: MapType<any>): Promise<MapType<string>>
    • +
+
    +
  • + +
    +
    +

    Builds the authorization, proxy authorization and SAP headers for a given destination.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      A destination.

      +
      +
      • +
    • +
      Optional customHeaders: MapType<any>
      +
      +

      Custom default headers for the resulting HTTP headers.

      +
      +
      • +
    +

    Returns Promise<MapType<string>>

    +

    HTTP headers for the given destination.

    +
    • +
+
+
+ +

buildHttpRequest

+ + +
+
+ +

checkMandatoryValue

+
    +
  • checkMandatoryValue<TypeScriptKeys, JwtKeys>(key: keyof TypeScriptKeys, mapping: JwtKeyMapping<TypeScriptKeys, JwtKeys>, decodedJWT: DecodedJWT): void
    • +
+
    +
  • + +
    +
    +

    Checks if a given key is in the decoded JWT. If not an error is raised

    +
    +
    +
    exception
    +

    Error is thrown if the key is not present.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      TypeScriptKeys

      +
      • +
    • +

      JwtKeys

      +
      • +
    +

    Parameters

    +
      +
    • +
      key: keyof TypeScriptKeys
      +
      +

      The key of the representation in typescript

      +
      +
      • +
    • +
      mapping: JwtKeyMapping<TypeScriptKeys, JwtKeys>
      +
      +

      The mapping between the typescript keys and the JWT key

      +
      +
      • +
    • +
      decodedJWT: DecodedJWT
      +
      +

      Decoded token on which the check is done

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

clientCredentialsGrant

+ +
    +
  • + +
    +
    +

    Executes a client credentials grant request. + If the first parameter is an instance of XsuaaServiceCredentials, the response's access_token will be verified. + If the first parameter is an URI, the response will not be verified.

    +
    +
    +

    Parameters

    +
      +
    • +
      xsuaaUriOrCredentials: string | XsuaaServiceCredentials
      +
      +

      The URI or the credentials of a XSUAA service instance.

      +
      +
      • +
    • +
      clientCredentials: ClientCredentials
      +
      +

      Client credentials for which to request a token

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to use by retrieving access token

      +
      +
      • +
    • +
      Default value customBody: MapType<any> = {}
      +
      +

      Object containing value required for the body request

      +
      +
      • +
    +

    Returns Promise<ClientCredentialsResponse>

    +

    A promise resolving to the response

    +
    • +
+
+
+ +

customAttributes

+
    +
  • customAttributes(decodedToken: DecodedJWT): Map<string, string[]>
    • +
+
    +
  • + +
    +
    +

    Extracts the custom attributes in the JWT

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the custom attributes

      +
      +
      • +
    +

    Returns Map<string, string[]>

    +

    custom attributes added by the xsuaa to the issued JWT.

    +
    • +
+
+
+ +

decodeJwt

+ +
    +
  • + +
    +
    +

    Decode JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: string
      +
      +

      JWT to be decoded

      +
      +
      • +
    +

    Returns DecodedJWT

    +

    Decoded payload.

    +
    • +
+
+
+ +

decodeJwtComplete

+ +
    +
  • + +
    +
    +

    Decode JWT and return the complete decoded token.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: string
      +
      +

      JWT to be decoded

      +
      +
      • +
    +

    Returns CompleteDecodedJWT

    +

    Decoded token containing payload, header and signature.

    +
    • +
+
+
+ +

destinationForServiceBinding

+ +
    +
  • + +
    +
    +

    Tries to build a destination from a service binding with the given name. + Throws an error if no services are bound at all, no service with the given name can be found, or the service type is not supported. + The last error can be circumvent by using the second parameter to provide a custom function that transforms a service binding to a destination.

    +
    +
    +

    Parameters

    +
      +
    • +
      serviceInstanceName: string
      +
      +

      The name of the service.

      +
      +
      • +
    • +
      Default value options: DestinationForServiceBindingsOptions = {}
      +
      +

      Options to customize the behavior of this function.

      +
      +
      • +
    +

    Returns Destination

    +

    A destination.

    +
    • +
+
+
+ +

execute

+ + +
+
+ +

extractClientCredentials

+ + +
+
+ +

fetchDestination

+
    +
  • fetchDestination(destinationServiceUri: string, jwt: string, destinationName: string, options?: ResilienceOptions): Promise<Destination>
    • +
+
    +
  • + +
    +
    +

    Fetches a specific destination by name from the given URI, including authorization tokens. + For destinations with authenticationType OAuth2SAMLBearerAssertion, this call will trigger the OAuth2SAMLBearerFlow against the target destination.

    +
    +
    +

    Parameters

    +
      +
    • +
      destinationServiceUri: string
      +
      +

      The URI of the destination service

      +
      +
      • +
    • +
      jwt: string
      +
      +

      The access token

      +
      +
      • +
    • +
      destinationName: string
      +
      +

      The name of the desired destination

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to use by retrieving destinations

      +
      +
      • +
    +

    Returns Promise<Destination>

    +

    A Promise resolving to the destination

    +
    • +
+
+
+ +

fetchInstanceDestinations

+ +
    +
  • + +
    +
    +

    Fetches all instance destinations from the given URI.

    +
    +
    +

    Parameters

    +
      +
    • +
      destinationServiceUri: string
      +
      +

      The URI of the destination service

      +
      +
      • +
    • +
      jwt: string
      +
      +

      The access token

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to use by retrieving destinations

      +
      +
      • +
    +

    Returns Promise<Destination[]>

    +

    A promise resolving to a list of instance destinations

    +
    • +
+
+
+ +

fetchSubaccountDestinations

+ +
    +
  • + +
    +
    +

    Fetches all subaccount destinations from the given URI.

    +
    +
    +

    Parameters

    +
      +
    • +
      destinationServiceUri: string
      +
      +

      The URI of the destination service

      +
      +
      • +
    • +
      jwt: string
      +
      +

      The access token

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to use by retrieving destinations

      +
      +
      • +
    +

    Returns Promise<Destination[]>

    +

    A promise resolving to a list of subaccount destinations

    +
    • +
+
+
+ +

fetchVerificationKeys

+
    +
  • fetchVerificationKeys(xsuaaCredentials: XsuaaServiceCredentials, jku?: undefined | string): Promise<TokenKey[]>
    • +
  • fetchVerificationKeys(url: string, clientId: string, clientSecret: string): Promise<TokenKey[]>
    • +
+
    +
  • + +
    +
    +

    Fetches verification keys from the XSUAA service for the given credentials.

    +
    +
    +

    Parameters

    +
      +
    • +
      xsuaaCredentials: XsuaaServiceCredentials
      +
      +

      Credentials of the XSUAA service instance.

      +
      +
      • +
    • +
      Optional jku: undefined | string
      +
      +

      Value of the jku property in the JWT header. If not provided the old legacy URL xsuaaCredentials.url/token_keys is used as a fallback which will not work for subscriber accounts created after 14th of April 2020.

      +
      +
      • +
    +

    Returns Promise<TokenKey[]>

    +

    An array of TokenKeys.

    +
    • +
  • + +
    +
    +

    Fetches verification keys from the XSUAA service for the given URL, with the given pair of credentials.

    +
    +
    +

    Parameters

    +
      +
    • +
      url: string
      +
      +

      URL of the XSUAA service instance.

      +
      +
      • +
    • +
      clientId: string
      +
      +

      Client ID of the XSUAA service instance.

      +
      +
      • +
    • +
      clientSecret: string
      +
      +

      Client secret of the XSUAA service instance.

      +
      +
      • +
    +

    Returns Promise<TokenKey[]>

    +

    An array of TokenKeys.

    +
    • +
+
+
+ +

filterFunction

+
    +
  • filterFunction<EntityT>(functionName: string, returnType: "boolean", ...parameters: FilterFunctionParameterType<EntityT>[]): BooleanFilterFunction<EntityT>
    • +
  • filterFunction<EntityT>(functionName: string, returnType: "int" | "double" | "decimal", ...parameters: FilterFunctionParameterType<EntityT>[]): NumberFilterFunction<EntityT>
    • +
  • filterFunction<EntityT>(functionName: string, returnType: "string", ...parameters: FilterFunctionParameterType<EntityT>[]): StringFilterFunction<EntityT>
    • +
+
    +
  • + +
    +
    +

    Build a custom OData (V2) filter function.

    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      functionName: string
      +
      +
      +

      the name of the function, e.g., substring

      +
      +
      +
      • +
    • +
      returnType: "boolean"
      +
      +
      +

      the return type of the filter function

      +
      +
      +
      • +
    • +
      Rest ...parameters: FilterFunctionParameterType<EntityT>[]
      +
      +
      +

      the parameter(s) used in the function

      +
      +
      +
      • +
    +

    Returns BooleanFilterFunction<EntityT>

    +

    An instance of filter function suited for the given return type

    +
    • +
  • + +
    +
    +

    Build a custom OData (V2) filter function.

    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      functionName: string
      +
      • +
    • +
      returnType: "int" | "double" | "decimal"
      +
      • +
    • +
      Rest ...parameters: FilterFunctionParameterType<EntityT>[]
      +
      • +
    +

    Returns NumberFilterFunction<EntityT>

    +

    An instance of filter function suited for the given return type

    +
    • +
  • + +
    +
    +

    Build a custom OData (V2) filter function.

    +
    +
    +

    Type parameters

    + +

    Parameters

    + +

    Returns StringFilterFunction<EntityT>

    +

    An instance of filter function suited for the given return type

    +
    • +
+
+
+ +

filterNullishValues

+
    +
  • filterNullishValues(headers?: MapType<any>): MapType<any>
    • +
+
    +
  • + +
    +
    +

    Filter headers that have nullish values.

    +
    +
    +

    Parameters

    +
      +
    • +
      Default value headers: MapType<any> = {}
      +
      +

      A header object to be filtered.

      +
      +
      • +
    +

    Returns MapType<any>

    +
      +
    • A filtered header object containing only headers with non-nullish values.
      • +
    +
    • +
+
+
+ +

getAgentConfig

+ +
    +
  • + +
    +
    +

    Returns the http or https-agent config depending on the destination URL. + If the destination contains a proxy configuration, the agent will be a proxy-agent. + If not it will be the default http-agent coming from node.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      determining which kind of configuration is returned

      +
      +
      • +
    +

    Returns HttpAgentConfig | HttpsAgentConfig

    +

    The http or http-agent configuration.

    +
    • +
+
+
+ +

getAxiosConfigWithDefaults

+ + +
+
+ +

getDestination

+ +
    +
  • + +
    +
    +

    Builds a destination from one of three sources (in the given order):

    +
      +
    • from the environment variable "destinations"
      • +
    • from service bindings
      • +
    • from the destination service
      • +
    +
    +

    If you want to get a destination only from a specific source, use the corresponding function directly + (getDestinationFromEnvByName, destinationForServiceBinding, getDestinationFromDestinationService).

    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name of the destination to be retrieved.

      +
      +
      • +
    • +
      Default value options: DestinationOptions = {}
      +
      +

      Configuration for how to retrieve destinations from the destination service.

      +
      +
      • +
    +

    Returns Promise<Destination | null>

    +

    A promise returning the requested destination on success.

    +
    • +
+
+
+ +

getDestinationBasicCredentials

+
    +
  • getDestinationBasicCredentials(): BasicCredentials
    • +
+
    +
  • + +
    +
    +

    Basic Credentials Getter from Destination service credentials needed for JWT generator.

    +
    +
    +

    Returns BasicCredentials

    +

    Basic credentials.

    +
    • +
+
+
+ +

getDestinationByName

+
    +
  • getDestinationByName(name: string): Destination | null
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.4.2. Use getDestinationFromEnvByName instead.

    +

    Get a destination from the environment variables by name. Throws an error if there are multiple destinations with the same name. + This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations + from the Cloud Foundry destination service.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      Name of the destination

      +
      +
      • +
    +

    Returns Destination | null

    +

    The requested destination if existent, otherwise null

    +
    • +
+
+
+ +

getDestinationFromDestinationService

+
    +
  • getDestinationFromDestinationService(name: string, options: DestinationOptions & { iss?: undefined | string }): Promise<Destination | null>
    • +
+
    +
  • + +
    +
    +

    Retrieves a destination with the given name from the Cloud Foundry destination service. + Returns null if no destination can be found. + Requires the following service bindings: destination, XSUAA + By default, selects subscriber over provider and instance over subaccount destinations.

    +
    +

    If the destinations are read from the environment, the jwt will be ignored.

    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name of the destination to be retrieved.

      +
      +
      • +
    • +
      options: DestinationOptions & { iss?: undefined | string }
      +
      +

      Configuration for how to retrieve destinations from the destination service.

      +
      +
      • +
    +

    Returns Promise<Destination | null>

    +

    A promise returning the requested destination on success.

    +
    • +
+
+
+ +

getDestinationFromEnvByName

+
    +
  • getDestinationFromEnvByName(name: string): Destination | null
    • +
+
    +
  • + +
    +
    +

    Get a destination from the environment variables by name. Throws an error if there are multiple destinations with the same name. + This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations + from the Cloud Foundry destination service.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      Name of the destination

      +
      +
      • +
    +

    Returns Destination | null

    +

    The requested destination if existent, otherwise null

    +
    • +
+
+
+ +

getDestinationOptions

+ +
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.0.1. Use getDestination instead.

    +

    Retrieves a destination with the given name from the Cloud Foundry destination service. + Returns null if no destination can be found. + Requires the following service bindings: destination, XSUAA + By default, selects subscriber over provider and instance over subaccount destinations.

    +

    If the destinations are read from the environment, the jwt will be ignored.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name of the destination to be retrieved.

      +
      +
      • +
    • +
      Default value options: DestinationOptions = {}
      +
      +

      The options of the fetching query of the destination that include the JWT of the current request and the strategy for selecting a destination.

      +
      +
      • +
    +

    Returns Promise<Destination | null>

    +

    A promise returning the requested destination on success.

    +
    • +
+
+
+ +

getDestinationServiceCredentials

+
    +
  • getDestinationServiceCredentials(): any
    • +
+ +
+
+ +

getDestinationServiceCredentialsList

+ + +
+
+ +

getDestinationServiceUri

+
    +
  • getDestinationServiceUri(): string | null
    • +
+
    +
  • + +
    +
    +

    Destination URI getter + NOTICE: If there exist more than one destination/uri, the function + returns the first entry.

    +
    +
    +

    Returns string | null

    +

    The first existing uri in destination or null if not found.

    +
    • +
+
+
+ +

getDestinations

+ +
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.4.2. Use getDestinationsFromEnv instead.

    +

    Get all destinations from the environment variable "destinations". + This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations + from the Cloud Foundry destination service.

    +
    +
    +
    +

    Returns Destination[]

    +

    A list of destinations

    +
    • +
+
+
+ +

getDestinationsFromEnv

+ + +
+
+ +

getEnvironmentVariable

+
    +
  • getEnvironmentVariable(name: string): string | undefined | null
    • +
+
    +
  • + +
    +
    +

    Environment variables accessor.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      Environment variable name.

      +
      +
      • +
    +

    Returns string | undefined | null

    +

    Env variable value if defined. + null: If not defined.

    +
    • +
+
+
+ +

getExpand

+
    +
  • getExpand<EntityT>(selects?: Selectable<EntityT>[]): Partial<{ expand: string }>
    • +
+ +
+
+ +

getGrantTokenCacheKey

+ + +
+
+ +

getHeader

+
    +
  • getHeader(key: string, headers?: MapType<any>): MapType<any>
    • +
+
    +
  • + +
    +
    +

    Find a header in a given header object, if available, idepdendent of the case (lower / upper).

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      Name of the header to be found.

      +
      +
      • +
    • +
      Default value headers: MapType<any> = {}
      +
      +

      Header object to be searched for given key.

      +
      +
      • +
    +

    Returns MapType<any>

    +
      +
    • An object containing the given key (and value) in its original case, as found in headers or an empty object if not found.
      • +
    +
    • +
+
+
+ +

getHeaderValue

+
    +
  • getHeaderValue(key: string, headers?: MapType<any>): any | undefined
    • +
+
    +
  • + +
    +
    +

    Get the value of a header based on the given key, independent of the case (lower / upper).

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      Name of the header to be found.

      +
      +
      • +
    • +
      Default value headers: MapType<any> = {}
      +
      +

      Header object to be searched for given key.

      +
      +
      • +
    +

    Returns any | undefined

    +

    The value of the header with the given key or undefined.

    +
    • +
+
+
+ +

getOAuth2ClientCredentialsToken

+
    +
  • getOAuth2ClientCredentialsToken(destination: Destination): Promise<ClientCredentialsResponse>
    • +
+
    +
  • + +
    +
    +

    Retrieves an access token required for "OAuth2ClientCredentials" destination authentication type.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      A destination having OAuth2ClientCredentials authentication type

      +
      +
      • +
    +

    Returns Promise<ClientCredentialsResponse>

    +

    A promise returning the requested access token on success.

    +
    • +
+
+
+ +

getProtocolOrDefault

+ +
    +
  • + +
    +
    +

    Extracts the http protocol from the destination url. The default value is http if no protocol is given.

    +
    +
    +
    throws
    +

    Error in case a unsupported protocol is given in the destination URL like rfc://example.com.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      URL of this destination is parsed

      +
      +
      • +
    +

    Returns Protocol

    +

    The protocol, either https or http.

    +
    • +
+
+
+ +

getQueryParametersForFilter

+
    +
  • getQueryParametersForFilter<EntityT>(filter: Filterable<EntityT>, entityConstructor: Constructable<EntityT>): Partial<{ filter: string }>
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.21.0. Use oDataUri.getFilter instead. + Get an object containing the given filter as query parameter, or an empty object if none was given.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      EntityT: Entity

      +
      +

      Type of the entity to filter on

      +
      +
      • +
    +

    Parameters

    +
      +
    • +
      filter: Filterable<EntityT>
      +
      +

      The filter to transform to a query parameter

      +
      +
      • +
    • +
      entityConstructor: Constructable<EntityT>
      +
      +

      Constructor type of the entity to filter on

      +
      +
      • +
    +

    Returns Partial<{ filter: string }>

    +

    An object containing the query parameter or an empty object

    +
    • +
+
+
+ +

getQueryParametersForOrderBy

+
    +
  • getQueryParametersForOrderBy<EntityT>(orderBy: Orderable<EntityT>[]): Partial<{ orderby: string }>
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.21.0. Use oDataUri.getOrderBy instead. + Get an object containing the given order bys as query parameter, or an empty object if none was given.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      EntityT: Entity

      +
      +

      Type of the entity to order

      +
      +
      • +
    +

    Parameters

    +
      +
    • +
      orderBy: Orderable<EntityT>[]
      +
      +

      A list of orderables to get the query parameters for

      +
      +
      • +
    +

    Returns Partial<{ orderby: string }>

    +

    An object containing the query parameter or an empty object

    +
    • +
+
+
+ +

getQueryParametersForSelection

+
    +
  • getQueryParametersForSelection<EntityT>(selects?: Selectable<EntityT>[]): Partial<{ expand: string; select: string }>
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.21.0. Use oDataUri.getSelect and oDataUri.getExpand instead.

    +

    Get an object containing the given Selectables as query parameter, or an empty object if none were given. + This retrieves where in addition to the selection (select) there is also an expansion (expand) needed.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      EntityT: Entity

      +
      +

      Type of the entity to get the selection for

      +
      +
      • +
    +

    Parameters

    +
      +
    • +
      Default value selects: Selectable<EntityT>[] = []
      +
      +

      The list of selectables to be transformed to query parameters

      +
      +
      • +
    +

    Returns Partial<{ expand: string; select: string }>

    +

    An object containing the query parameters or an empty object

    +
    • +
+
+
+ +

getRequestLine

+
    +
  • getRequestLine(requestBuilder: MethodRequestBuilderBase<ODataRequestConfig>): string
    • +
+
    +
  • + +
    +
    +

    Generate the request line, containing method, url and http version from the request builder, e.g.: + GET /sap/opu/odata/sap/API_BUSINESS_PARTNER/A_BusinessPartnerAddress?$format=json&$top=1 HTTP/1.1

    +
    +
    +

    Parameters

    +
      +
    • +
      requestBuilder: MethodRequestBuilderBase<ODataRequestConfig>
      +
      +

      Reqeust builder holds the request information.

      +
      +
      • +
    +

    Returns string

    +

    the generated request line.

    +
    • +
+
+
+ +

getResourcePathForKeys

+
    +
  • getResourcePathForKeys<EntityT>(keys?: MapType<FieldType>, entityConstructor: Constructable<EntityT>): string
    • +
+
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.21.0. Use oDataUri.getResourcePathForKeys instead. + Get the resource path of an entity specified by key-value pairs.

    +
    +
    +
    +

    Type parameters

    +
      +
    • +

      EntityT: EntityBase

      +
      +

      Type of the entity to get the resource path for

      +
      +
      • +
    +

    Parameters

    +
      +
    • +
      Default value keys: MapType<FieldType> = {}
      +
      +

      Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value

      +
      +
      • +
    • +
      entityConstructor: Constructable<EntityT>
      +
      +

      Constructor type of the entity to get the resource path for

      +
      +
      • +
    +

    Returns string

    +

    The path to the resource

    +
    • +
+
+
+ +

getSelect

+
    +
  • getSelect<EntityT>(selects?: Selectable<EntityT>[]): Partial<{ select: string }>
    • +
+
    +
  • + +
    +
    +

    Get an object containing the given Selectables as query parameter, or an empty object if none were given. + This retrieves where in addition to the selection (select) there is also an expansion (expand) needed.

    +
    +
    +

    Type parameters

    +
      +
    • +

      EntityT: Entity

      +
      +

      Type of the entity to get the selection for

      +
      +
      • +
    +

    Parameters

    +
      +
    • +
      Default value selects: Selectable<EntityT>[] = []
      +
      +

      The list of selectables to be transformed to query parameters

      +
      +
      • +
    +

    Returns Partial<{ select: string }>

    +

    An object containing the query parameters or an empty object

    +
    • +
+
+
+ +

getService

+
    +
  • getService(service: string): Service | undefined
    • +
+
    +
  • + +
    +
    +

    Returns the first found instance for the given service type.

    +
    +
    +

    Parameters

    +
      +
    • +
      service: string
      +
      +

      The service type.

      +
      +
      • +
    +

    Returns Service | undefined

    +

    The first found service.

    +
    • +
+
+
+ +

getServiceCredentialsList

+
    +
  • getServiceCredentialsList(service: string): any[]
    • +
+
    +
  • + +
    +
    +

    Credentials list getter for a given service.

    +
    +
    +

    Parameters

    +
      +
    • +
      service: string
      +
      +

      Service name

      +
      +
      • +
    +

    Returns any[]

    +

    Fetched credentials objects of existing service in 'VCAP_SERVICES'.

    +
    • +
+
+
+ +

getServiceList

+
    +
  • getServiceList(service: string): Service[]
    • +
+
    +
  • + +
    +
    +

    Services getter for a given service.

    +
    +
    +

    Parameters

    +
      +
    • +
      service: string
      +
      +

      Service name.

      +
      +
      • +
    +

    Returns Service[]

    +

    List of service bindings of the given type. Returns an empty array if no service binding exists for the given type.

    +
    • +
+
+
+ +

getUrlProtocol

+ +
    +
  • + +
    +
    +
    deprecated
    +

    Since v1.5.1. use getProtocolOrDefault instead + Takes the destination URL and return everything before the '://'.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      URL of this destination is parsed

      +
      +
      • +
    +

    Returns Protocol | undefined

    +

    The protocol either undefined if no :// is found or anything before the delimiter.

    +
    • +
+
+
+ +

getVcapService

+
    +
  • getVcapService(): MapType<any> | null
    • +
+
    +
  • + +
    +
    +

    'VCAP_SERVICES' Getter from environment variables. + This function returns the VCAP_SERVICES as object or null if it is not defined (i.e. no services are bound to the application).

    +
    +
    +

    Returns MapType<any> | null

    +

    'VCAP_SERVICES' found in environment variables or null if not defined. The key denotes the name ov the service and the value is the definition.

    +
    • +
+
+
+ +

getXsuaaServiceCredentials

+ +
    +
  • + +
    +
    +

    Takes a decoded JWT and uses the client_id and audience claims to determine the XSUAA service instance + that issued the JWT. Returns the credentials if a match is found, otherwise throws an error. + If no decoded JWT is specified, then returns the first existing XSUAA credential service plan "application".

    +
    +
    +

    Parameters

    +
      +
    • +
      Optional token: DecodedJWT | string
      +
      +

      Either an encoded or decoded JWT.

      +
      +
      • +
    +

    Returns XsuaaServiceCredentials

    +

    The credentials for a match, otherwise null.

    +
    • +
+
+
+ +

headerForClientCredentials

+ + +
+
+ +

isDestination

+
    +
  • isDestination(destination: any): destination is Destination
    • +
+ +
+
+ +

isDestinationNameAndJwt

+
    +
  • isDestinationNameAndJwt(destination: any): destination is DestinationNameAndJwt
    • +
+ +
+
+ +

isIdenticalTenant

+ +
    +
  • + +
    +
    +

    Compare two decoded JWTs based on their tenantIds.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedUserToken: DecodedJWT
      +
      +

      User JWT

      +
      +
      • +
    • +
      decodedProviderToken: DecodedJWT
      +
      +

      Provider JWT

      +
      +
      • +
    +

    Returns boolean

    +

    Whether the tenant is identical.

    +
    • +
+
+
+ +

issuerUrl

+
    +
  • issuerUrl(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the issuer url of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the issuer url from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The issuer url if available.

    +
    • +
+
+
+ +

length

+
    +
  • length<EntityT>(p0: string | Field<EntityT> | StringFilterFunction<EntityT>): NumberFilterFunction<EntityT>
    • +
+
    +
  • + +
    +
    +

    Build an OData (V2) filter function to get the length of a string.

    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      p0: string | Field<EntityT> | StringFilterFunction<EntityT>
      +
      +

      the given string for computing the length

      +
      +
      • +
    +

    Returns NumberFilterFunction<EntityT>

    +

    The newly created filter function

    +
    • +
+
+
+ +

Const nonEnumerable

+
    +
  • nonEnumerable(target: any, propertyKey: string): void
    • +
+ +
+
+ +

parseDestination

+ +
    +
  • + +
    +
    +

    Takes a JSON object returned by any of the calls to the destination service and returns an SDK compatible destination object. + This function only accepts destination configurations of type 'HTTP' and will error if no 'URL' is given.

    +
    +
    +

    Parameters

    + +

    Returns Destination

    +

    An SDK compatible destination object.

    +
    • +
+
+
+ +

parseProxyEnv

+ +
    +
  • + +
    +
    +

    Parses the environment variable for the web proxy and extracts the values considering defaults like http for the protocol and 80 or 443 for the port. + The general pattern to be parsed is protocol://user:password@host:port, where everything besides the host is optional. + Special characters in the user and password need to be percent encoded.

    +
    +
    +

    Parameters

    +
      +
    • +
      proxyEnvValue: string
      +
      +

      Environment variable which is parsed

      +
      +
      • +
    +

    Returns ProxyConfiguration | undefined

    +

    Configuration with default values or undefined if the parsing failed.

    +
    • +
+
+
+ +

proxyAgent

+ +
    +
  • + +
    +
    +

    Builds the http(s)-agent config. Note that the proxy agent type like http or https is determined by the destination RUL protocol. + The protocol from the proxy is unrelated to this and in most cases http.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      Destination containing the proxy configurations

      +
      +
      • +
    +

    Returns HttpAgentConfig | HttpsAgentConfig

    +

    The http(s)-agent containing the proxy configuration

    +
    • +
+
+
+ +

proxyStrategy

+ +
    +
  • + +
    +
    +

    Determines the proxy strategy. If noProxy is set the ProxyConfiguration in the destination is omitted. + For onPremProxy or internetProxy the connectivy service or enviroment variables are checked to fill the ProxyConfiguration.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      from which the proxy strategy is derived.

      +
      +
      • +
    +

    Returns ProxyStrategy

    +

    ProxyStrategy possible values are noProxy, internetProxy or onPremProxy.

    +
    • +
+
+
+ +

refreshTokenGrant

+ +
    +
  • + +
    +
    +

    Executes a refresh token grant request against the given URI. + If the first parameter is an instance of XsuaaServiceCredentials, the response's access_token will be verified. + If the first parameter is an URI, the response will not be verified.

    +
    +
    +

    Parameters

    +
      +
    • +
      xsuaaUriOrCredentials: string | XsuaaServiceCredentials
      +
      +

      The URI or the credentials of a XSUAA service instance.

      +
      +
      • +
    • +
      clientCredentials: ClientCredentials
      +
      +

      The credentials (client_id, client_secret) if the target XSUAA service instance.

      +
      +
      • +
    • +
      refreshToken: string
      +
      +

      The refresh token that should be used to generate a new access token.

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to use by retrieving access token.

      +
      +
      • +
    +

    Returns Promise<UserTokenResponse>

    +

    A promise resolving to the response of the XSUAA service.

    +
    • +
+
+
+ +

replaceDuplicateKeys

+
    +
  • replaceDuplicateKeys(headers?: MapType<any>, customHeaders?: MapType<any>): MapType<any>
    • +
+
    +
  • + +
    +
    +

    Create a header object by replacing headers that are set as custom headers.

    +
    +
    +

    Parameters

    +
      +
    • +
      Default value headers: MapType<any> = {}
      +
      +

      A base header object that contains the headers that will be compared with customHeaders.

      +
      +
      • +
    • +
      Default value customHeaders: MapType<any> = {}
      +
      +

      A header object to be compared with headers. Only headers present in headers will be compared.

      +
      +
      • +
    +

    Returns MapType<any>

    +
      +
    • An object containing all keys from the original headers object, where headers present in the customHeaders are replaced. Note that the case (upper / lower) used by customHeaders will be used.
      • +
    +
    • +
+
+
+ +

resolveService

+ +
    +
  • + +
    +
    +

    Takes a string that represents the service type and resolves it by calling getService. + If the parameter is already an instance of Service, it is returned directly.

    +
    +

    Throws an error when no service can be found for the given type.

    +
    +

    Parameters

    +
      +
    • +
      service: string | Service
      +
      +

      A string representing the service type or a Service instance.

      +
      +
      • +
    +

    Returns Service

    +

    A Service instance.

    +
    • +
+
+
+ +

retrieveJwt

+
    +
  • retrieveJwt(req: IncomingMessage): string | undefined
    • +
+
    +
  • + +
    +
    +

    Retrieve JWT from a request that is based on the node IncomingMessage. Fails if no authorization header is given or has the wrong format. Expected format is 'Bearer '.

    +
    +
    +

    Parameters

    +
      +
    • +
      req: IncomingMessage
      +
      +

      Request to retrieve the JWT from

      +
      +
      • +
    +

    Returns string | undefined

    +

    JWT found in header

    +
    • +
+
+
+ +

sanitizeDestination

+
    +
  • sanitizeDestination(destination: MapType<any>): Destination
    • +
+
    +
  • + +
    +
    +

    Takes an existing or a parsed destination and returns an SDK compatible destination object.

    +
    +
    +

    Parameters

    +
      +
    • +
      destination: MapType<any>
      +
      +

      An object that adheres to the Destination interface.

      +
      +
      • +
    +

    Returns Destination

    +

    An SDK compatible destination object.

    +
    • +
+
+
+ +

serviceToken

+ +
    +
  • + +
    +
    +

    Returns an access token that can be used to call the given service. The token is fetched via a client credentials grant with the credentials of the given service. + If multiple instances of the provided service exist, the first instance will be selected. + When a JWT is passed, the tenant of the JWT will be used when performing the grant. + When no JWT is passed, the grant will be performed using the provider tenant.

    +
    +

    Throws an error if there is no instance of the given service type or the XSUAA service, or if the request to the XSUAA service fails.

    +
    +

    Parameters

    + +

    Returns Promise<string>

    +

    Access token.

    +
    • +
+
+
+ +

subscriberFirst

+
    +
  • subscriberFirst(allDestinations: AllDestinations, destinationName: string): Destination | null
    • +
+
    +
  • + +
    +
    +

    Prioritizes the selection of subscriber destinations.

    +
    +
    +

    Parameters

    +
      +
    • +
      allDestinations: AllDestinations
      +
      +

      Retrieved destinations

      +
      +
      • +
    • +
      destinationName: string
      +
      +

      Name of the destination to retrieve

      +
      +
      • +
    +

    Returns Destination | null

    +

    the destination to retrieve, returns null if no matched destination is found

    +
    • +
+
+
+ +

substring

+
    +
  • substring<EntityT>(p0: string | Field<EntityT> | StringFilterFunction<EntityT>, pos: number | Field<EntityT> | NumberFilterFunction<EntityT>): StringFilterFunction<EntityT>
    • +
+
    +
  • + +
    +
    +

    Build an OData (V2) filter function to get a substring starting from a designated position. Evaluates to string.

    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      p0: string | Field<EntityT> | StringFilterFunction<EntityT>
      +
      +

      the original string. This can either be a string, a reference to a field or another filter function.

      +
      +
      • +
    • +
      pos: number | Field<EntityT> | NumberFilterFunction<EntityT>
      +
      +

      the starting position of the original string. This can be either a number, a reference to a field or another filter function.

      +
      +
      • +
    +

    Returns StringFilterFunction<EntityT>

    +

    The newly created filter function

    +
    • +
+
+
+ +

substringOf

+
    +
  • substringOf<EntityT>(p0: string | Field<EntityT> | StringFilterFunction<EntityT>, p1: string | Field<EntityT> | StringFilterFunction<EntityT>): BooleanFilterFunction<EntityT>
    • +
+
    +
  • + +
    +
    +

    Build an OData (V2) filter function to test whether a string is a substring of the other. Evaluates to boolean.

    +
    +
    +

    Type parameters

    + +

    Parameters

    +
      +
    • +
      p0: string | Field<EntityT> | StringFilterFunction<EntityT>
      +
      +

      The substring to test for. This can either be a string, a reference to a field or another filter function.

      +
      +
      • +
    • +
      p1: string | Field<EntityT> | StringFilterFunction<EntityT>
      +
      +

      The string to test. This can either be a string, a reference to a field or another filter function.

      +
      +
      • +
    +

    Returns BooleanFilterFunction<EntityT>

    +

    The newly created filter function

    +
    • +
+
+
+ +

tenantFromJwt

+ +
    +
  • + +
    +
    +

    Creates a tenant object from the decoded JWT.

    +
    +
    +
    exception
    +

    Error Raised if no id is found in the decoded JWT.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      decodedJWT: DecodedJWT
      +
      +

      Decoded JWT token

      +
      +
      • +
    +

    Returns Tenant

    +

    Representation of the tenant.

    +
    • +
+
+
+ +

tenantId

+
    +
  • tenantId(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the tenant id of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the tenant id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The tenant id if available.

    +
    • +
+
+
+ +

tenantName

+
    +
  • tenantName(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the tenant name of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the tenant id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The tenant id if available.

    +
    • +
+
+
+ +

toBatchChangeSet

+ + +
+
+ +

toBatchRetrieveBody

+ +
    +
  • + +
    +
    +

    Build a string as the request body of the retrieve request. + Below is an example of the generated body, where the two empty line are mandatory to make the request valid. + * example starts * + Content-Type: application/http + Content-Transfer-Encoding: binary

    +
    +

    GET /SomeUrl/API_BUSINESS_PARTNER/A_BusinessPartnerBank?$format=json&$top=1 HTTP/1.1

    +

    * example ends *

    +
    +

    Parameters

    + +

    Returns string

    +

    The request body.

    +
    • +
+
+
+ +

toPascalCase

+
    +
  • toPascalCase(str: string): string
    • +
+
    +
  • + +
    +
    +

    Converts a string to PascalCase format e.g. "MyNameInPascalCase".

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      The string to be transformed.

      +
      +
      • +
    +

    Returns string

    +

    The transformed string.

    +
    • +
+
+
+ +

toPropertyFormat

+
    +
  • toPropertyFormat(str: string): string
    • +
+
    +
  • + +
    +
    +

    Converts a string to the format used by properties. Use this for serialization.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      The string to be transformed.

      +
      +
      • +
    +

    Returns string

    +

    The transformed string.

    +
    • +
+
+
+ +

toSanitizedHeaderObject

+
    +
  • toSanitizedHeaderObject(key: string, value: any): MapType<any>
    • +
+
    +
  • + +
    +
    +

    Create a header object based on the given key and value if neither key nor value are nullish.

    +
    +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +

      Name of the header.

      +
      +
      • +
    • +
      value: any
      +
      +

      Value of the header.

      +
      +
      • +
    +

    Returns MapType<any>

    +
      +
    • An object containing the given key and value of an empty object.
      • +
    +
    • +
+
+
+ +

toStaticPropertyFormat

+
    +
  • toStaticPropertyFormat(str: string): string
    • +
+
    +
  • + +
    +
    +

    Converts a string to the case used by static methods on entity classes. Use this for serialization.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      The string to be transformed.

      +
      +
      • +
    +

    Returns string

    +

    The input string in the case used by static methods on entity-classes.

    +
    • +
+
+
+ +

toTitleFormat

+
    +
  • toTitleFormat(str: string): string
    • +
+
    +
  • + +
    +
    +

    Converts a string to a human readable format, e.g. it transforms to_BusinessPartner to To Business Partner. Use this for serialization.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      The string to be transformed.

      +
      +
      • +
    +

    Returns string

    +

    The transformed string.

    +
    • +
+
+
+ +

toTypeNameFormat

+
    +
  • toTypeNameFormat(str: string): string
    • +
+
    +
  • + +
    +
    +

    Converts a string to the format used by properties. Use this for serialization.

    +
    +
    +

    Parameters

    +
      +
    • +
      str: string
      +
      +

      The string to be transformed.

      +
      +
      • +
    +

    Returns string

    +

    The transformed string.

    +
    • +
+
+
+ +

transformReturnValueForComplexType

+
    +
  • transformReturnValueForComplexType<ReturnT>(data: any, builderFn: (data: any) => ReturnT): ReturnT
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      ReturnT

      +
      • +
    +

    Parameters

    +
      +
    • +
      data: any
      +
      • +
    • +
      builderFn: (data: any) => ReturnT
      +
        +
      • +
          +
        • (data: any): ReturnT
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: any
            +
            • +
          +

          Returns ReturnT

          +
          • +
        +
        • +
      +
      • +
    +

    Returns ReturnT

    +
    • +
+
+
+ +

transformReturnValueForComplexTypeList

+
    +
  • transformReturnValueForComplexTypeList<ReturnT>(data: any, builderFn: (data: any) => ReturnT): ReturnT[]
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      ReturnT

      +
      • +
    +

    Parameters

    +
      +
    • +
      data: any
      +
      • +
    • +
      builderFn: (data: any) => ReturnT
      +
        +
      • +
          +
        • (data: any): ReturnT
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: any
            +
            • +
          +

          Returns ReturnT

          +
          • +
        +
        • +
      +
      • +
    +

    Returns ReturnT[]

    +
    • +
+
+
+ +

transformReturnValueForEdmType

+
    +
  • transformReturnValueForEdmType<ReturnT>(data: any, builderFn: (data: any) => ReturnT): ReturnT
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      ReturnT

      +
      • +
    +

    Parameters

    +
      +
    • +
      data: any
      +
      • +
    • +
      builderFn: (data: any) => ReturnT
      +
        +
      • +
          +
        • (data: any): ReturnT
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: any
            +
            • +
          +

          Returns ReturnT

          +
          • +
        +
        • +
      +
      • +
    +

    Returns ReturnT

    +
    • +
+
+
+ +

transformReturnValueForEdmTypeList

+
    +
  • transformReturnValueForEdmTypeList<ReturnT>(data: any, builderFn: (data: any) => ReturnT): ReturnT[]
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      ReturnT

      +
      • +
    +

    Parameters

    +
      +
    • +
      data: any
      +
      • +
    • +
      builderFn: (data: any) => ReturnT
      +
        +
      • +
          +
        • (data: any): ReturnT
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: any
            +
            • +
          +

          Returns ReturnT

          +
          • +
        +
        • +
      +
      • +
    +

    Returns ReturnT[]

    +
    • +
+
+
+ +

transformReturnValueForEntity

+
    +
  • transformReturnValueForEntity<ReturnT>(data: any, entityConstructor: Constructable<ReturnT>): ReturnT
    • +
+ +
+
+ +

transformReturnValueForEntityList

+
    +
  • transformReturnValueForEntityList<ReturnT>(data: any, entityConstructor: Constructable<ReturnT>): ReturnT[]
    • +
+ +
+
+ +

transformReturnValueForUndefined

+
    +
  • transformReturnValueForUndefined<ReturnT>(data: any, builderFn: (data: any) => ReturnT): ReturnT
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      ReturnT

      +
      • +
    +

    Parameters

    +
      +
    • +
      data: any
      +
      • +
    • +
      builderFn: (data: any) => ReturnT
      +
        +
      • +
          +
        • (data: any): ReturnT
          • +
        +
          +
        • +

          Parameters

          +
            +
          • +
            data: any
            +
            • +
          +

          Returns ReturnT

          +
          • +
        +
        • +
      +
      • +
    +

    Returns ReturnT

    +
    • +
+
+
+ +

useOrFetchDestination

+ +
    +
  • + +
    +
    +

    Returns the parameter if it is a destination, calls getDestination otherwise (which will try to fetch the destination + from the Cloud Foundry destination service).

    +
    +

    Fetching a destination requires:

    +
      +
    • a binding to exactly one XSUAA service instance with service plan "application"
      • +
    • a binding to a destination service instance
      • +
    +

    If either of the prerequisites is not met or one of the services returns an error, this function will either throw an error or return a promise that rejects.

    +
    +

    Parameters

    + +

    Returns Promise<Destination | null>

    +

    A promise resolving to the requested destination on success.

    +
    • +
+
+
+ +

userApprovedServiceToken

+
    +
  • userApprovedServiceToken(userJwt: string, service: string | Service, options?: ResilienceOptions): Promise<string>
    • +
+
    +
  • + +
    +
    +

    Returns a user approved access token that can be used to call the given service on behalf of the given user. The token is fetched via user token + refresh token grant. + This can be necessary for scenarios in which a token for a service is required, but the service needs + to know about the user on whose behalf the request is performed (for example to let the destination + service perform principal propagation with SAP S/4HANA Cloud).

    +
    +

    Throws an error if there is no instance of the given service type or the XSUAA service, or if the request to the XSUAA service fails.

    +
    +

    Parameters

    +
      +
    • +
      userJwt: string
      +
      +

      The JWT of the user for whom the access token should be fetched.

      +
      +
      • +
    • +
      service: string | Service
      +
      +

      The type of the service or an instance of Service.

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to influence resilience behavior (see ResilienceOptions). By default, usage of a circuit breaker is enabled.

      +
      +
      • +
    +

    Returns Promise<string>

    +

    A user approved access token.

    +
    • +
+
+
+ +

userEmail

+
    +
  • userEmail(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the user's email of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the user id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The user id if available.

    +
    • +
+
+
+ +

userFamilyName

+
    +
  • userFamilyName(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the user's family name of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the user id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The user id if available.

    +
    • +
+
+
+ +

userFromJwt

+ +
    +
  • + +
    +
    +

    Creates a user object from the decoded JWT.

    +
    +
    +
    exception
    +

    Error Raised if no id is found in the decoded JWT.

    +
    +
    +
    +

    Parameters

    +
      +
    • +
      decodedJWT: DecodedJWT
      +
      +

      Decoded JWT toeken

      +
      +
      • +
    +

    Returns User

    +

    Representation of the user

    +
    • +
+
+
+ +

userGivenName

+
    +
  • userGivenName(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the user's given name of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the user id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The user id if available.

    +
    • +
+
+
+ +

userId

+
    +
  • userId(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the user id of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the user id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The user id if available.

    +
    • +
+
+
+ +

userName

+
    +
  • userName(decodedToken: DecodedJWT): string | undefined
    • +
+
    +
  • + +
    +
    +

    Get the user name of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the user id from.

      +
      +
      • +
    +

    Returns string | undefined

    +

    The user id if available.

    +
    • +
+
+
+ +

userScopes

+ +
    +
  • + +
    +
    +

    Get the user's scopes of a decoded JWT.

    +
    +
    +

    Parameters

    +
      +
    • +
      decodedToken: DecodedJWT
      +
      +

      Token to read the user id from.

      +
      +
      • +
    +

    Returns Scope[] | []

    +

    The user id if available.

    +
    • +
+
+
+ +

userTokenGrant

+
    +
  • userTokenGrant(xsuaaUri: string, userJwt: string, clientId: string, options?: ResilienceOptions): Promise<UserTokenResponse>
    • +
+
    +
  • + +
    +
    +

    Executes a user token grant request against the given URI.

    +
    +
    +

    Parameters

    +
      +
    • +
      xsuaaUri: string
      +
      +

      The URI of the target XSUAA service instance.

      +
      +
      • +
    • +
      userJwt: string
      +
      +

      The JWT of the user on whose behalf the request is executed.

      +
      +
      • +
    • +
      clientId: string
      +
      +

      The client_id of the target XSUAA service instance.

      +
      +
      • +
    • +
      Optional options: ResilienceOptions
      +
      +

      Options to use by retrieving access token

      +
      +
      • +
    +

    Returns Promise<UserTokenResponse>

    +

    A promise resolving to the response of the XSUAA service.

    +
    • +
+
+
+ +

verifyJwt

+ +
    +
  • + +
    +
    +

    Verifies the given JWT and returns the decoded payload.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: string
      +
      +

      JWT to be verified

      +
      +
      • +
    • +
      Optional options: VerifyJwtOptions
      +
      +

      Options to control certain aspects of JWT verification behavior.

      +
      +
      • +
    +

    Returns Promise<DecodedJWT>

    +

    A Promise to the decoded and verified JWT.

    +
    • +
+
+
+ +

verifyJwtWithKey

+
    +
  • verifyJwtWithKey(token: string, key: string): Promise<DecodedJWT>
    • +
+
    +
  • + +
    +
    +

    Verifies the given JWT with the given key and returns the decoded payload.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: string
      +
      +

      JWT to be verified

      +
      +
      • +
    • +
      key: string
      +
      +

      Key to use for verification

      +
      +
      • +
    +

    Returns Promise<DecodedJWT>

    +

    A Promise to the decoded and verified JWT.

    +
    • +
+
+
+ +

wrapJwtInHeader

+
    +
  • wrapJwtInHeader(token: string): AxiosRequestConfig
    • +
+
    +
  • + +
    +
    +

    Wraps the access token in header's authorization.

    +
    +
    +

    Parameters

    +
      +
    • +
      token: string
      +
      +

      Token to attach in request header

      +
      +
      • +
    +

    Returns AxiosRequestConfig

    +

    The request header that holds the access token

    +
    • +
+
+
+
+

Object literals

+
+ +

Const DestinationSelectionStrategies

+
DestinationSelectionStrategies: object
+ +
+
+

Selector of destination selection strategies. See alwaysProvider, alwaysSubscriber and subscriberFirst for more information available selection strategies.

+
+
+
+ +

alwaysProvider

+
alwaysProvider: alwaysProvider
+ +
+
+ +

alwaysSubscriber

+
alwaysSubscriber: alwaysSubscriber
+ +
+
+ +

subscriberFirst

+
subscriberFirst: subscriberFirst
+ +
+
+
+ +

Const EnvironmentAccessor

+
EnvironmentAccessor: object
+ +
+
+
deprecated
+

Since v1.5.0. Use directly exported functions instead

+
+
+
+
+ +

getDestinationBasicCredentials

+
getDestinationBasicCredentials: getDestinationBasicCredentials
+ +
+
+ +

getDestinationServiceCredentials

+
getDestinationServiceCredentials: getDestinationServiceCredentials
+ +
+
+ +

getDestinationServiceCredentialsList

+
getDestinationServiceCredentialsList: getDestinationServiceCredentialsList
+ +
+
+ +

getDestinationServiceUri

+
getDestinationServiceUri: getDestinationServiceUri
+ +
+
+ +

getEnvironmentVariable

+
getEnvironmentVariable: getEnvironmentVariable
+ +
+
+ +

getServiceCredentialsList

+
getServiceCredentialsList: getServiceCredentialsList
+ +
+
+ +

getServiceList

+
getServiceList: getServiceList
+ +
+
+ +

getVcapService

+
getVcapService: getVcapService
+ +
+
+ +

getXsuaaServiceCredentials

+
getXsuaaServiceCredentials: getXsuaaServiceCredentials
+ +
+
+
+ +

Const circuitBreakerDefaultOptions

+
circuitBreakerDefaultOptions: object
+ +
+ +

errorThresholdPercentage

+
errorThresholdPercentage: number = 50
+ +
+
+ +

resetTimeout

+
resetTimeout: number = 30000
+ +
+
+ +

timeout

+
timeout: number = 10000
+ +
+
+
+ +

Const mapping

+
mapping: object
+ +
+
+

Mapping between key name in the Tenant and key name in decoded JWT and the

+
+
+
+ +

id

+
id: object
+ +
+ +

extractorFunction

+
extractorFunction: tenantId = tenantId
+ +
+
+ +

keyInJwt

+
keyInJwt: "zid" = "zid"
+ +
+
+
+ +

name

+
name: object
+ +
+ +

extractorFunction

+
extractorFunction: tenantName = tenantName
+ +
+
+ +

keyInJwt

+
keyInJwt: "zdn" = "zdn"
+ +
+
+
+
+ +

Const mapping

+
mapping: object
+ +
+
+

Mapping between key name in the User and key name in decoded JWT and the

+
+
+
+ +

customAttributes

+
customAttributes: object
+ +
+ +

extractorFunction

+
extractorFunction: customAttributes = customAttributes
+ +
+
+ +

keyInJwt

+
keyInJwt: "xs.user.attributes" = "xs.user.attributes"
+ +
+
+
+ +

email

+
email: object
+ +
+ +

extractorFunction

+
extractorFunction: userEmail = userEmail
+ +
+
+ +

keyInJwt

+
keyInJwt: "email" = "email"
+ +
+
+
+ +

familyName

+
familyName: object
+ +
+ +

extractorFunction

+
extractorFunction: userFamilyName = userFamilyName
+ +
+
+ +

keyInJwt

+
keyInJwt: "family_name" = "family_name"
+ +
+
+
+ +

givenName

+
givenName: object
+ +
+ +

extractorFunction

+
extractorFunction: userGivenName = userGivenName
+ +
+
+ +

keyInJwt

+
keyInJwt: "given_name" = "given_name"
+ +
+
+
+ +

id

+
id: object
+ +
+ +

extractorFunction

+
extractorFunction: userId = userId
+ +
+
+ +

keyInJwt

+
keyInJwt: "user_id" = "user_id"
+ +
+
+
+ +

scopes

+
scopes: object
+ +
+ +

extractorFunction

+
extractorFunction: userScopes = userScopes
+ +
+
+ +

keyInJwt

+
keyInJwt: "scope" = "scope"
+ +
+
+
+ +

userName

+
userName: object
+ +
+ +

extractorFunction

+
extractorFunction: userName = userName
+ +
+
+ +

keyInJwt

+
keyInJwt: "user_name" = "user_name"
+ +
+
+
+
+ +

Const oDataUri

+
oDataUri: object
+ +
+
+
experimental
+

This is experimental and is subject to change. Use with caution.

+
+
+
+
+ +

convertToUriFormat

+
convertToUriFormat: convertToUriFormat
+ +
+
+ +

getEntityKeys

+
getEntityKeys: getEntityKeys
+ +
+
+ +

getExpand

+
getExpand: getExpand
+ +
+
+ +

getFilter

+
getFilter: getFilter = createGetFilter({ convertToUriFormat }).getFilter
+ +
+
+ +

getOrderBy

+
getOrderBy: getOrderBy
+ +
+
+ +

getSelect

+
getSelect: getSelect
+ +
+
+ +

getResourcePathForKeys

+
    +
  • getResourcePathForKeys<EntityT>(keys?: MapType<FieldType>, entityConstructor: Constructable<EntityT>): string
    • +
+ +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/modules/sap_cloud_sdk_generator.html b/docs/api/1.21.0/modules/sap_cloud_sdk_generator.html new file mode 100644 index 0000000000..5cc64f226a --- /dev/null +++ b/docs/api/1.21.0/modules/sap_cloud_sdk_generator.html @@ -0,0 +1,3199 @@ + + + + + + @sap-cloud-sdk/generator | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @sap-cloud-sdk/generator

+
+
+
+
+
+
+
+
+

SAP Cloud SDK for JavaScript Logo

+ +

@sap-cloud-sdk/generator

+ +

Generate your own service module using a service specification (.edmx file).

+ +

Installation

+ + 
$ npm install @sap-cloud-sdk/generator
+ +

Usage

+ +

The generator is primarily meant to be used on the command line:

+ 
generate-odata-client --inputDir path/to/your/service-specification(s) --outputDir path/where/the/modules/are/stored
+

Run generate-odata-client --help for further options.

+

You can also use the generator programmatically. You will have to provide the options anyways.

+ 
import { generateProject } from '@sap-cloud-sdk/generator';
+
+// initialize generator options based on what you want to do
+const options: GeneratorOptions = initializeOptions();
+
+// creates a Project datastructure with all sourcefiles based on your options
+const project = generateProject(options);
+
+// here you can modify you project if you need to
+
+// save the files at the specified location
+project.save();
+
+// alternatively you can generate and save the project in one step with: generate(options)
+ +

Api documentation

+ +

https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts

+ +

Helpful Links

+ + +
+
+
+

Index

+
+
+
+

Enumerations

+ +
+
+

Classes

+ +
+
+

Interfaces

+ +
+
+

Variables

+ +
+
+

Functions

+ +
+
+
+
+
+

Variables

+
+ +

Const VALUE_IS_UNDEFINED

+
VALUE_IS_UNDEFINED: "VALUE_IS_UNDEFINED" = "VALUE_IS_UNDEFINED"
+ +
+
+ +

Const applyPrefixOnJsConfictFunctionImports

+
applyPrefixOnJsConfictFunctionImports: (Anonymous function) = applyPrefixOnJSReservedWords('f')
+ +
+
+ +

Const applyPrefixOnJsConfictParam

+
applyPrefixOnJsConfictParam: (Anonymous function) = applyPrefixOnJSReservedWords('p')
+ +
+
+ +

Const applySuffixOnConflictDash

+
applySuffixOnConflictDash: (Anonymous function) = applySuffixOnConflict('-')
+ +
+
+ +

Const applySuffixOnConflictUnderscore

+
applySuffixOnConflictUnderscore: (Anonymous function) = applySuffixOnConflict('_')
+ +
+
+
+

Functions

+
+ +

addLeadingNewline

+
    +
  • addLeadingNewline(documentation: string): string
    • +
+
    +
  • + +
    +
    +

    Adds a leading \n to a documentation string so that the ts-morph makes a block comment out of it.

    +
    +
    +

    Parameters

    +
      +
    • +
      documentation: string
      +
      +

      text.

      +
      +
      • +
    +

    Returns string

    +

    documentation text with leading \n.

    +
    • +
+
+
+ +

batchFunction

+ + +
+
+ +

batchSourceFile

+ + +
+
+ +

builderFunction

+
    +
  • builderFunction(complexType: VdmComplexType): FunctionDeclarationStructure
    • +
+ +
+
+ +

changesetFunction

+ + +
+
+ +

cloudSdkVdmHack

+
    +
  • cloudSdkVdmHack(name: string): string
    • +
+ +
+
+ +

complexTypeImportDeclarations

+
    +
  • complexTypeImportDeclarations(properties: VdmProperty[]): ImportDeclarationStructure[]
    • +
+ +
+
+ +

complexTypeInterface

+
    +
  • complexTypeInterface(complexType: VdmComplexType): InterfaceDeclarationStructure
    • +
+ +
+
+ +

complexTypeNamespace

+
    +
  • complexTypeNamespace(complexType: VdmComplexType): NamespaceDeclarationStructure
    • +
+ +
+
+ +

complexTypeSourceFile

+
    +
  • complexTypeSourceFile(complexType: VdmComplexType): SourceFileStructure
    • +
+ +
+
+ +

copyFile

+
    +
  • copyFile(fromPath: string, toRelativePath: string, toDirectory: Directory, overwrite: boolean): void
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      fromPath: string
      +
      • +
    • +
      toRelativePath: string
      +
      • +
    • +
      toDirectory: Directory
      +
      • +
    • +
      overwrite: boolean
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

coreImportDeclaration

+
    +
  • coreImportDeclaration(namedImports: string[]): ImportDeclarationStructure
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      namedImports: string[]
      +
      • +
    +

    Returns ImportDeclarationStructure

    +
    • +
+
+
+ +

coreNavPropertyFieldTypeImportNames

+ + +
+
+ +

corePropertyFieldTypeImportNames

+
    +
  • corePropertyFieldTypeImportNames(properties: VdmProperty[]): string[]
    • +
+ +
+
+ +

corePropertyTypeImportNames

+ + +
+
+ +

csn

+ + +
+
+ +

edmToComplexPropertyType

+
    +
  • edmToComplexPropertyType(edmType: string): string
    • +
+ +
+
+ +

edmToFieldType

+
    +
  • edmToFieldType(edmType: string): string
    • +
+ +
+
+ +

edmToTsType

+
    +
  • edmToTsType(edmType: string): string
    • +
+ +
+
+ +

edmxPaths

+
    +
  • edmxPaths(input: PathLike): PathLike[]
    • +
+ +
+
+ +

endWithDot

+
    +
  • endWithDot(text: string): string
    • +
+ +
+
+ +

ensureString

+
    +
  • ensureString(obj: any): string
    • +
+ +
+
+ +

entityClass

+ + +
+
+ +

entityNamespace

+ + +
+
+ +

entitySourceFile

+ + +
+
+ +

entityTypeForceMandatoryInterface

+ + +
+
+ +

entityTypeInterface

+ + +
+
+ +

exportStatement

+
    +
  • exportStatement(functionImports: VdmFunctionImport[]): VariableStatementStructure
    • +
+ +
+
+ +

externalImportDeclaration

+
    +
  • externalImportDeclaration(properties: VdmMappedEdmType[], moduleSpecifier: string, namedImports: string[]): ImportDeclarationStructure
    • +
+ +
+
+ +

externalImportDeclarations

+
    +
  • externalImportDeclarations(properties: VdmMappedEdmType[]): ImportDeclarationStructure[]
    • +
+ +
+
+ +

fieldTypeClass

+
    +
  • fieldTypeClass(complexType: VdmComplexType): ClassDeclarationStructure
    • +
+ +
+
+ +

forceArray

+
    +
  • forceArray(obj: any): any[]
    • +
+ +
+
+ +

functionImportFunction

+ + +
+
+ +

functionImportParametersInterface

+
    +
  • functionImportParametersInterface(functionImport: VdmFunctionImport): InterfaceDeclarationStructure
    • +
+ +
+
+ +

functionImportSourceFile

+ + +
+
+ +

generate

+
    +
  • generate(options: GeneratorOptions): Promise<void | EmitResult[]>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      options: GeneratorOptions
      +
      • +
    +

    Returns Promise<void | EmitResult[]>

    +
    • +
+
+
+ +

generateProject

+
    +
  • generateProject(options: GeneratorOptions): Promise<Project | undefined>
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      options: GeneratorOptions
      +
      • +
    +

    Returns Promise<Project | undefined>

    +
    • +
+
+
+ +

generateSourcesForService

+
    +
  • generateSourcesForService(service: VdmServiceMetadata, project: Project, options: GeneratorOptions): Promise<void>
    • +
+ +
+
+ +

Const genericDescription

+
    +
  • genericDescription(packageName: string): string
    • +
+ +
+
+ +

getComplexTypeFieldDescription

+
    +
  • getComplexTypeFieldDescription(complexType: VdmComplexType): string
    • +
+ +
+
+ +

getComplexTypePropertyDescription

+
    +
  • getComplexTypePropertyDescription(property: VdmProperty, complexTypeName: string): string
    • +
+ +
+
+ +

getEntityDescription

+ + +
+
+ +

getFunctionDoc

+
    +
  • getFunctionDoc(description: string, tags: Partial<{ params: NamedDocType[]; returns: DocType; typeparams: DocType[] }>): string
    • +
+ +
+
+ +

getLookupDescription

+ + +
+
+ +

getNavPropertyDescription

+ + +
+
+ +

getPropertyDescription

+ + +
+
+ +

getRequestBuilderDescription

+
    +
  • getRequestBuilderDescription(entity: VdmEntity): string
    • +
+ +
+
+ +

getRoot

+
    +
  • getRoot(edmx: any): any
    • +
+ +
+
+ +

getStaticNavPropertyDescription

+ + +
+
+ +

getStaticPropertyDescription

+
    +
  • getStaticPropertyDescription(property: VdmProperty): string
    • +
+ +
+
+ +

hasComplexTypeProperty

+
    +
  • hasComplexTypeProperty(properties: VdmProperty[]): boolean
    • +
+ +
+
+ +

hasEdmTypeProperty

+
    +
  • hasEdmTypeProperty(properties: VdmProperty[]): boolean
    • +
+ +
+
+ +

helpfulLinksSection

+
    +
  • helpfulLinksSection(): string[]
    • +
+ +
+
+ +

importBatchDeclarations

+ + +
+
+ +

importDeclarations

+
    +
  • importDeclarations(complexType: VdmComplexType): ImportDeclarationStructure[]
    • +
+ +
+
+ +

importDeclarations

+
    +
  • importDeclarations(entity: VdmEntity): ImportDeclarationStructure[]
    • +
+ +
+
+ +

importDeclarations

+ + +
+
+ +

importDeclarations

+
    +
  • importDeclarations(entity: VdmEntity): ImportDeclarationStructure[]
    • +
+ +
+
+ +

indexFile

+ + +
+
+ +

inputPaths

+ + +
+
+ +

isCreatable

+
    +
  • isCreatable(entity: any): boolean
    • +
+ +
+
+ +

isDeletable

+
    +
  • isDeletable(entity: any): boolean
    • +
+ +
+
+ +

isFilterable

+
    +
  • isFilterable(property: any): boolean
    • +
+ +
+
+ +

isNullableParameter

+
    +
  • isNullableParameter(parameter: any): boolean
    • +
+ +
+
+ +

isNullableProperty

+
    +
  • isNullableProperty(property: any): boolean
    • +
+ +
+
+ +

isSortable

+
    +
  • isSortable(property: any): boolean
    • +
+ +
+
+ +

isUpdatable

+
    +
  • isUpdatable(entity: any): boolean
    • +
+ +
+
+ +

linkClass

+ + +
+
+ +

mergeImportDeclarations

+
    +
  • mergeImportDeclarations(importDeclarations: ImportDeclarationStructure[]): ImportDeclarationStructure[]
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      importDeclarations: ImportDeclarationStructure[]
      +
      • +
    +

    Returns ImportDeclarationStructure[]

    +
    • +
+
+
+ +

npmCompliantName

+
    +
  • npmCompliantName(name: string): string
    • +
+
    +
  • + +
    +
    +

    Takes a name and returns a transformation that is guaranteed to be compliant with npm naming rules.

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      The name to be transformed if necessary.

      +
      +
      • +
    +

    Returns string

    +

    Name that is guaranteed to be compliant.

    +
    • +
+
+
+ +

npmrc

+
    +
  • npmrc(): string
    • +
+ +
+
+ +

otherEntityImports

+ + +
+
+ +

otherFile

+
    +
  • otherFile(directory: Directory, relativePath: string, content: string, overwrite: boolean): SourceFile
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      directory: Directory
      +
      • +
    • +
      relativePath: string
      +
      • +
    • +
      content: string
      +
      • +
    • +
      overwrite: boolean
      +
      • +
    +

    Returns SourceFile

    +
    • +
+
+
+ +

packageJson

+
    +
  • packageJson(npmPackageName: string, dependencies: string[], versionInPackageJson: string | undefined, generatorVersion: string): string
    • +
+ +
+
+ +

packageJson

+
    +
  • packageJson(npmPackageName: string, versionInPackageJson: string | undefined, generatorVersion: string, description: string, sdkAfterVersionScript: boolean): string
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      npmPackageName: string
      +
      • +
    • +
      versionInPackageJson: string | undefined
      +
      • +
    • +
      generatorVersion: string
      +
      • +
    • +
      description: string
      +
      • +
    • +
      sdkAfterVersionScript: boolean
      +
      • +
    +

    Returns string

    +
    • +
+
+
+ +

parseAllServices

+ + +
+
+ +

parseCmdArgs

+
    +
  • parseCmdArgs(): GeneratorOptions
    • +
+ +
+
+ +

parseEdmxFromPath

+ + +
+
+ +

parseService

+ + +
+
+ +

parseSwaggerFromPath

+ + +
+
+ +

prefixString

+
    +
  • prefixString(string: string, prefix?: undefined | string): string
    • +
+
    +
  • + +
    +
    +

    Applies a prefix to a string if present.

    +
    +
    +

    Parameters

    +
      +
    • +
      string: string
      +
      +

      The string to be prefixed.

      +
      +
      • +
    • +
      Optional prefix: undefined | string
      +
      +

      The optional prefix.

      +
      +
      • +
    +

    Returns string

    +

    Prefixed string.

    +
    • +
+
+
+ +

prependPrefix

+
    +
  • prependPrefix(name: string): string
    • +
+ +
+
+ +

readRequestType

+ + +
+
+ +

readServiceMapping

+
    +
  • readServiceMapping(options: GeneratorOptions): VdmMapping
    • +
+ +
+
+ +

readme

+ + +
+
+ +

readme

+ + +
+
+ +

requestBuilderClass

+
    +
  • requestBuilderClass(entity: VdmEntity): ClassDeclarationStructure
    • +
+ +
+
+ +

requestBuilderSourceFile

+
    +
  • requestBuilderSourceFile(entity: VdmEntity): SourceFileStructure
    • +
+ +
+
+ +

responseTransformerFunctionName

+ + +
+
+ +

Const s4hanaCloudDescription

+
    +
  • s4hanaCloudDescription(packageName: string): string
    • +
+ +
+
+ +

serviceMapping

+ + +
+
+ +

serviceMappingFile

+ + +
+
+ +

sourceFile

+
    +
  • sourceFile(directory: Directory, relativePath: string, content: SourceFileStructure, overwrite: boolean): SourceFile
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      directory: Directory
      +
      • +
    • +
      relativePath: string
      +
      • +
    • +
      content: SourceFileStructure
      +
      • +
    • +
      overwrite: boolean
      +
      • +
    +

    Returns SourceFile

    +
    • +
+
+
+ +

stripCollection

+
    +
  • stripCollection(name: string): string
    • +
+ +
+
+ +

stripPrefix

+
    +
  • stripPrefix(name: string): string
    • +
+ +
+
+ +

tsConfig

+
    +
  • tsConfig(): string
    • +
+ +
+
+ +

typedocJson

+
    +
  • typedocJson(): string
    • +
+ +
+
+ +

writeReqeustType

+ + +
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/modules/sap_cloud_sdk_test_util.html b/docs/api/1.21.0/modules/sap_cloud_sdk_test_util.html new file mode 100644 index 0000000000..631207823a --- /dev/null +++ b/docs/api/1.21.0/modules/sap_cloud_sdk_test_util.html @@ -0,0 +1,473 @@ + + + + + + @sap-cloud-sdk/test-util | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @sap-cloud-sdk/test-util

+
+
+
+
+
+
+
+
+

SAP Cloud SDK for JavaScript Logo

+ +

@sap-cloud-sdk/test-util

+ +

Package that contains utility functions for testing, like loading credentials or creating test destinations.

+ +

Installation

+ + 
$ npm install @sap-cloud-sdk/test-util
+ +

Usage

+ +

The test-util package makes writing tests for your SAP Cloud Platform application more convenient.

+

For example, you can create a mock destination for your tests by using the function mockTestDestination.

+ 
import { mockTestDestination } from '@sap-cloud-sdk/util';
+mockTestDestination('mockDestinationName');

You need to save your system information in local file systems.json:

+ 
{
+    "systems": [
+        {
+            "alias": "mockDestinationName",
+            "uri": "https://www.example.com"
+        }
+    ]
+}
+

and credentials.json:

+ 
{
+  "credentials": [
+    {
+      "alias": "SYS_001",
+      "username": "username",
+      "password": "password"
+    }
+  ]
+}
+ +

Api documentation

+ +

https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts

+ +

Helpful Links

+ + +
+
+
+

Index

+
+
+
+

Interfaces

+ +
+
+

Functions

+ +
+
+
+
+
+

Functions

+
+ +

getTestDestinationByAlias

+ +
    +
  • + +
    +
    +

    Loads a destination matching the provided alias stored in systems.json and credentials.json. + By default, this function starts looking in the directory the test process has been started in (i.e. '.') + and traverses the file hierarchy upwards until it finds a systems.json and credentials.json file. + Alternatively, you can supply paths to the systems and the credentials file directly.

    +
    +

    Throws an error when no systems.json can be found, the alias does not match any of the available destinations, + the JSON is malformed or one of the supplied paths is invalid. + Does not throw an error when no credentials.json can be found, but will print a warning.

    +
    +

    Parameters

    +
      +
    • +
      alias: string
      +
      +

      The alias identifying the destination

      +
      +
      • +
    • +
      Optional options: GetTestDestinationOptions
      +
      +

      References to the systems.json and credentials.json files

      +
      +
      • +
    +

    Returns Destination

    +

    An array of destinations

    +
    • +
+
+
+ +

getTestDestinations

+ +
    +
  • + +
    +
    +

    Loads all destinations stored in systems.json and credentials.json files.

    +
    +

    By default, this functions starts looking in the directory the test process has been started in (i.e. '.') + and traverses the file hierarchy upwards until it finds a systems.json and credentials.json file. + Alternatively, you can supply paths to the systems and the credentials file directly.

    +

    Throws an error when no systems.json can be found, the JSON is malformed or one of the supplied paths is invalid. + Does not throw an error when no credentials.json can be found, but will print a warning.

    +
    +

    Parameters

    + +

    Returns Destination[]

    +

    An array of destinations

    +
    • +
+
+
+ +

mockAllTestDestinations

+ +
    +
  • + +
    +
    +

    Add all destinations from the systems.json and credentials.json files to the destinations environment variable.

    +
    +

    Throws an error if a destination with the same name as the given test destinations already exists.

    +
    +

    Parameters

    + +

    Returns void

    +
    • +
+
+
+ +

mockTestDestination

+ +
    +
  • + +
    +
    +

    Add a destination with the given name from the systems.json and credentials.json files to the destinations environment variable.

    +
    +

    Throws an error if a destination with the same name as the given test destination already exists.

    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      Name of the test destination to add to the destinations environment variable

      +
      +
      • +
    • +
      Optional options: GetTestDestinationOptions
      +
      +

      References to the systems.json and credentials.json files

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

setTestDestination

+
    +
  • setTestDestination(destination: Destination): void
    • +
+
    +
  • + +
    +
    +

    Set a given destination in the destinations environment variable.

    +
    +

    Throws an error if a destination with the same name as the given test destination already exists.

    +
    +

    Parameters

    +
      +
    • +
      destination: Destination
      +
      +

      Test destination to add to the destinations environment variable

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

unmockAllTestDestinations

+
    +
  • unmockAllTestDestinations(): void
    • +
+ +
+
+ +

unmockTestDestination

+
    +
  • unmockTestDestination(name: string): void
    • +
+
    +
  • + +
    +
    +

    Removes a destination with the given name from the destinations environment variable. If the given destination name is not found calling this function has no effect. + This function should be called to invert the behavior of mockTestDestination() and setTestDestination().

    +
    +
    +

    Parameters

    +
      +
    • +
      name: string
      +
      +

      Name of the mocked destination to remove

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/1.21.0/modules/sap_cloud_sdk_util.html b/docs/api/1.21.0/modules/sap_cloud_sdk_util.html new file mode 100644 index 0000000000..c72a6e9e1d --- /dev/null +++ b/docs/api/1.21.0/modules/sap_cloud_sdk_util.html @@ -0,0 +1,943 @@ + + + + + + @sap-cloud-sdk/util | SAP Cloud SDK for JavaScript / TypeScript - v1.21.0 + + + + + +
+
+
+
+ +
+
+ Options +
+
+ All +
    +
  • Public
    • +
  • Public/Protected
    • +
  • All
    • +
+
+ + + + +
+
+ Menu +
+
+
+
+
+
+ +

Module @sap-cloud-sdk/util

+
+
+
+
+
+
+
+
+

SAP Cloud SDK for JavaScript Logo

+ +

@sap-cloud-sdk/util

+ +

Package that contains general utility functions that we reuse multiple times in the SDK. + While primarily designed for internal usage, they might also be beneficial for consumers of the SDK.

+ +

Installation

+ + 
$ npm install @sap-cloud-sdk/util
+ +

Usage

+ +

The util package collects useful tools that help build your SAP Cloud Platform application. + For example, the following code snippet changes the log level of the destination accessor of the SDK.

+ 
import { setLogLevel } from '@sap-cloud-sdk/util';
+setLogLevel('debug', 'destination-accessor');
+ +

Api documentation

+ +

https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts

+ +

Helpful Links

+ + +
+
+
+

Index

+
+
+
+

Interfaces

+ +
+
+

Type aliases

+ +
+
+

Variables

+ +
+
+

Functions

+ +
+
+
+
+
+

Type aliases

+
+ +

LogLevel

+
LogLevel: "error" | "warn" | "info" | "verbose" | "debug" | "silly"
+ +
+
+

Npm log levels used for the SAP Cloud SDK logger.

+
+
+
+
+
+

Variables

+
+ +

Const VALUE_IS_UNDEFINED

+
VALUE_IS_UNDEFINED: "VALUE_IS_UNDEFINED" = "VALUE_IS_UNDEFINED"
+ +
+
+ +

Const cloudSdkExceptionLogger

+
cloudSdkExceptionLogger: Logger = container.get(exceptionLoggerId, {defaultMeta: { logger: loggerReference, test: 'exception' },format,exceptionHandlers: [exceptionTransport]})
+ +
+
+

Default logger for the SAP Cloud SDK for unhandled exceptions.

+
+
+
+
+ +

Const kibana

+
kibana: Format = combine(errors({ stack: true }),timestamp(),format(info => ({...info,msg: info.message,written_ts: new Date(info.timestamp).getTime(),written_at: info.timestamp}))(),json())
+ +
+
+

Format for logging in Kibana.

+
+
+
+
+ +

Const local

+
local: Format = combine(errors({ stack: true }),timestamp(),format(info => ({...info,level: info.level.toUpperCase()}))(),cli(),printf(info => {const messageContext =info.custom_fields && info.custom_fields.messageContext? `${chalk.blue(`(${info.custom_fields.messageContext})`)}: `: '';const trimmedMessage = info.message.replace(/^\s*/, '');const paddingLength =info.message.length - trimmedMessage.length + messageContext.length;if (info.error) {info.level = chalk.inverse(info.level);}return `${chalk.gray(`[${info.timestamp}]`)} ${info.level} ${messageContext.padStart(paddingLength, ' ')}${trimmedMessage}`;}))
+ +
+
+

Format for local logging.

+
+
+
+
+
+

Functions

+
+ +

Const assocSome

+
    +
  • assocSome<T>(key: string, value?: any): (Anonymous function)
    • +
+
    +
  • + +
    +
    +

    Calls rambda's assoc function if the provided value is neither null nor undefined. + Note that this is different to JS idiomatic checks for truthy/falsy values, i.e. an empty string will result in assoc being called.

    +
    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Parameters

    +
      +
    • +
      key: string
      +
      +
      +

      The key to associate with the given value.

      +
      +
      +
      • +
    • +
      Optional value: any
      +
      +
      +

      The value to associate with the given key.

      +
      +
      +
      • +
    +

    Returns (Anonymous function)

    +

    A copy of the input object with the new key-value pair if the value is neither null nor undefined.

    +
    • +
+
+
+ +

Const asyncPipe

+
    +
  • asyncPipe(...fns: any[]): (Anonymous function)
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      Rest ...fns: any[]
      +
      • +
    +

    Returns (Anonymous function)

    +
    • +
+
+
+ +

createLogger

+ +
    +
  • + +
    +
    +

    Create a logger for the given message context, if available.

    +
    +

    Usage: + To create a logger in your module, it is recommended to pass a module identifier that will be logged as messageContext for all messages from this logger: + const logger = createLogger('my-module');. Not setting any module identifier will retrieve the default logger. + Use this logger throughout your module. If the module is spread over multiple files, you can retrieve the logger instance by calling the createLogger function with the respective module identifier. + There will always be only one instance of a logger per module identifier. + You can pass any custom data that you want to be logged in addition by passing an object instead. You can change the default logging level (INFO) using the level key in the object. + In those cases, provide the messageContext as a key in the object:

    + 
    const logger = createLogger({
+  messageContext: 'my-module',
+  myCustomKey: 'my-custom-data',
+  level: 'debug'
+});

    You will find these information under the custom_fields key in your Cloud Foundry logs.

    +

    To retrieve a logger after its creation use getLogger. + If you want to change the log level of a logger use setLogLevel.

    +
    +

    Parameters

    +
      +
    • +
      Optional messageContext: string | (MessageContextObj & LoggerOptions)
      +
      +

      Either a key for the message context of all messages produced by the logger or an object with additional keys to set in the message.

      +
      +
      • +
    +

    Returns Logger

    +

    A newly created or an already existing logger for the given context.

    +
    • +
+
+
+ +

disableExceptionLogger

+
    +
  • disableExceptionLogger(): void
    • +
+ +
+
+ +

enableExceptionLogger

+
    +
  • enableExceptionLogger(): void
    • +
+ +
+
+ +

encodeBase64

+
    +
  • encodeBase64(str: string): string
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      str: string
      +
      • +
    +

    Returns string

    +
    • +
+
+
+ +

errorWithCause

+
    +
  • errorWithCause(message: string, cause: Error): Error
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      message: string
      +
      • +
    • +
      cause: Error
      +
      • +
    +

    Returns Error

    +
    • +
+
+
+ +

findProjectRoot

+
    +
  • findProjectRoot(path: string, lastPath?: string): string
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      path: string
      +
      • +
    • +
      Default value lastPath: string = path
      +
      • +
    +

    Returns string

    +
    • +
+
+
+ +

flat

+
    +
  • flat<T>(arr: T[][]): T[]
    • +
+
    +
  • + +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Parameters

    +
      +
    • +
      arr: T[][]
      +
      • +
    +

    Returns T[]

    +
    • +
+
+
+ +

getGlobalLogLevel

+
    +
  • getGlobalLogLevel(): string | undefined
    • +
+ +
+
+ +

getLogger

+
    +
  • getLogger(messageContext?: string): Logger | undefined
    • +
+
    +
  • + +
    +
    +

    Get logger for a given message context, if avilable.

    +
    +
    +

    Parameters

    +
      +
    • +
      Default value messageContext: string = DEFAULT_LOGGER__MESSAGE_CONTEXT
      +
      +

      A key for the message context of all messages produced by the logger

      +
      +
      • +
    +

    Returns Logger | undefined

    +

    The logger for the given messageContext if it was created before

    +
    • +
+
+
+ +

isNullish

+
    +
  • isNullish(x: any): x is null | undefined
    • +
+
    +
  • + +

    Parameters

    +
      +
    • +
      x: any
      +
      • +
    +

    Returns x is null | undefined

    +
    • +
+
+
+ +

Const mergeSome

+ +
    +
  • + +
    +
    +

    Calls rambda's merge function if second object is neither null nor undefined.

    +
    +
    +

    Parameters

    +
      +
    • +
      a: MapType<any>
      +
      +
      +

      The object to merge into.

      +
      +
      +
      • +
    • +
      Optional b: MapType<any>
      +
      +
      +

      The object which to merge into a.

      +
      +
      +
      • +
    +

    Returns MapType<any>

    +

    A copy of the merge(a, b) or a if b is undefined or null.

    +
    • +
+
+
+ +

propertyExists

+
    +
  • propertyExists(obj: object, ...properties: string[]): boolean
    • +
+
    +
  • + +
    +
    +

    Checks if a chain of properties exists on the given object.

    +
    +
    +

    Parameters

    +
      +
    • +
      obj: object
      +
      +

      The object to be checked.

      +
      +
      • +
    • +
      Rest ...properties: string[]
      +
      +

      Chained properties.

      +
      +
      • +
    +

    Returns boolean

    +

    True if the property chain leads to a truthy value, false otherwise.

    +
    • +
+
+
+ +

Const renameKeys

+ +
    +
  • + +
    +
    +

    Takes an object and returns a new object whose keys are renamed according to the provided key mapping. + Any keys in the input object not present in the key mapping will be present in the output object as-is. + If a key in the key mapping is not present in the input object, the output object will contain the key with value "undefined".

    +
    +
    +

    Parameters

    +
      +
    • +
      keyMapping: MapType<string>
      +
      +
      +

      An object mapping keys of the input object to keys of the output object.

      +
      +
      +
      • +
    • +
      obj: MapType<any>
      +
      +
      +

      The input object.

      +
      +
      +
      • +
    +

    Returns MapType<any>

    +

    An object with renamed keys.

    +
    • +
+
+
+ +

setGlobalLogLevel

+
    +
  • setGlobalLogLevel(level: LogLevel): void
    • +
+
    +
  • + +
    +
    +

    Change the global log level of the container which will set default level for all active loggers. + E. g., to set the global log level call setGlobalLogLevel('debug').

    +
    +
    +

    Parameters

    + +

    Returns void

    +
    • +
+
+
+ +

setLogLevel

+
    +
  • setLogLevel(level: LogLevel | "", messageContextOrLogger?: string | Logger): void
    • +
+
    +
  • + +
    +
    +

    Change the log level of a logger based on its message context. + E. g., to set the log level for the destination accessor module of the SDK to _debug_, simply call setLogLevel('debug', 'destination-acessor').

    +
    +
    +

    Parameters

    +
      +
    • +
      level: LogLevel | ""
      +
      +

      level to set the logger to. Use an empty string '' as level to unset context level.

      +
      +
      • +
    • +
      Default value messageContextOrLogger: string | Logger = DEFAULT_LOGGER__MESSAGE_CONTEXT
      +
      +

      Message context of the logger to change the log level for or the logger itself

      +
      +
      • +
    +

    Returns void

    +
    • +
+
+
+ +

unique

+
    +
  • unique<T>(words: T[]): T[]
    • +
+
    +
  • + +
    +
    +

    Remove all duplicates from array

    +
    +
    +

    Type parameters

    +
      +
    • +

      T

      +
      • +
    +

    Parameters

    +
      +
    • +
      words: T[]
      +
      +

      Array of strings that might contain duplicates

      +
      +
      • +
    +

    Returns T[]

    +

    Array of unique strings

    +
    • +
+
+
+
+
+ + +
+
+
+
+
+

Legend

+
+
    +
  • Object literal
    • +
  • Variable
    • +
  • Function
    • +
  • Function with type parameter
    • +
  • Type alias
    • +
  • Type alias with type parameter
    • +
+
    +
  • Interface
    • +
  • Interface with type parameter
    • +
+
    +
  • Class
    • +
  • Class with type parameter
    • +
+
    +
  • Enumeration
    • +
+
+
+

Copyright Ⓒ 2020 SAP SE or an SAP affiliate company. All rights reserved.

+
+
+ + + + \ No newline at end of file diff --git a/docs/api/versions.js b/docs/api/versions.js index e38dbba4f6..01fe9df255 100644 --- a/docs/api/versions.js +++ b/docs/api/versions.js @@ -1,4 +1,5 @@ export default [ + "1.21.0", "1.20.1", "1.20.0", "1.19.0", diff --git a/docs/api/versions.json b/docs/api/versions.json index 0330b2badd..c1839e215d 100644 --- a/docs/api/versions.json +++ b/docs/api/versions.json @@ -1,4 +1,5 @@ [ + "1.21.0", "1.20.1", "1.20.0", "1.19.0", diff --git a/lerna.json b/lerna.json index b44f77924b..c9e5891375 100644 --- a/lerna.json +++ b/lerna.json @@ -9,5 +9,5 @@ "test-packages/test-services", "test-packages/type-tests" ], - "version": "1.20.1" + "version": "1.21.0" } diff --git a/packages/analytics/package-lock.json b/packages/analytics/package-lock.json index d6e6b3ddf0..96456ed852 100644 --- a/packages/analytics/package-lock.json +++ b/packages/analytics/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/analytics", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/analytics/package.json b/packages/analytics/package.json index dfad433ac8..9ef95385ac 100644 --- a/packages/analytics/package.json +++ b/packages/analytics/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/analytics", - "version": "1.20.1", + "version": "1.21.0", "description": "SAP Cloud SDK Analytics Usage", "homepage": "https://community.sap.com/topics/cloud-sdk", "license": "Apache-2.0", @@ -30,7 +30,7 @@ "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --config ./jest-local.json" }, "dependencies": { - "@sap-cloud-sdk/util": "^1.20.1", + "@sap-cloud-sdk/util": "^1.21.0", "axios": "^0.19.2" }, "devDependencies": { diff --git a/packages/core/package-lock.json b/packages/core/package-lock.json index 25977221d4..079562f67f 100644 --- a/packages/core/package-lock.json +++ b/packages/core/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/core", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/core/package.json b/packages/core/package.json index b85b855ab1..5c93bc0b7a 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/core", - "version": "1.20.1", + "version": "1.21.0", "description": "SAP Cloud SDK for JavaScript core", "homepage": "https://community.sap.com/topics/cloud-sdk", "license": "Apache-2.0", @@ -34,8 +34,8 @@ "test:debug-name-regex": "node -r ts-node/register --inspect-brk ./node_modules/.bin/jest --config jest-local.json --runInBand --testNamePattern=\"$PATTERN\"" }, "dependencies": { - "@sap-cloud-sdk/analytics": "^1.20.1", - "@sap-cloud-sdk/util": "^1.20.1", + "@sap-cloud-sdk/analytics": "^1.21.0", + "@sap-cloud-sdk/util": "^1.21.0", "@sap/xsenv": "^2.2.0", "axios": "^0.19.2", "bignumber.js": "^9.0.0", diff --git a/packages/generator/package-lock.json b/packages/generator/package-lock.json index cf20bd31a9..1477c03488 100644 --- a/packages/generator/package-lock.json +++ b/packages/generator/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/generator", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/generator/package.json b/packages/generator/package.json index cd52a22060..eb16a1e763 100644 --- a/packages/generator/package.json +++ b/packages/generator/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/generator", - "version": "1.20.1", + "version": "1.21.0", "description": "SAP Cloud SDK for JavaScript OData client generator", "homepage": "https://community.sap.com/topics/cloud-sdk", "license": "Apache-2.0", @@ -34,8 +34,8 @@ "test:watch-debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand --config ./jest-local.json" }, "dependencies": { - "@sap-cloud-sdk/core": "^1.20.1", - "@sap-cloud-sdk/util": "^1.20.1", + "@sap-cloud-sdk/core": "^1.21.0", + "@sap-cloud-sdk/util": "^1.21.0", "@sap/edm-converters": "^1.0.21", "@types/fs-extra": "^8.1.0", "fast-xml-parser": "^3.16.0", @@ -47,7 +47,7 @@ "yargs": "^15.3.1" }, "devDependencies": { - "@sap-cloud-sdk/test-services": "^1.20.1", + "@sap-cloud-sdk/test-services": "^1.21.0", "@types/jest": "^25.1.4", "@types/yargs": "^15.0.4", "jest": "^25.2.4", diff --git a/packages/test-util/package-lock.json b/packages/test-util/package-lock.json index 98a1d41042..0626d5c243 100644 --- a/packages/test-util/package-lock.json +++ b/packages/test-util/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-util", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/test-util/package.json b/packages/test-util/package.json index c78e7dc237..1792ee5c56 100644 --- a/packages/test-util/package.json +++ b/packages/test-util/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-util", - "version": "1.20.1", + "version": "1.21.0", "description": "SAP Cloud SDK for JavaScript test utilities", "homepage": "https://community.sap.com/topics/cloud-sdk", "license": "Apache-2.0", @@ -30,8 +30,8 @@ "test:debug": "node --inspect-brk node_modules/.bin/jest --runInBand --config ./jest-local.json" }, "dependencies": { - "@sap-cloud-sdk/core": "^1.20.1", - "@sap-cloud-sdk/util": "^1.20.1" + "@sap-cloud-sdk/core": "^1.21.0", + "@sap-cloud-sdk/util": "^1.21.0" }, "devDependencies": { "@types/jest": "^25.1.4", diff --git a/packages/util/package-lock.json b/packages/util/package-lock.json index 545c60eb89..d900fa4e64 100644 --- a/packages/util/package-lock.json +++ b/packages/util/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/util", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/packages/util/package.json b/packages/util/package.json index 0e99ef941d..f4ce017099 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/util", - "version": "1.20.1", + "version": "1.21.0", "description": "SAP Cloud SDK for JavaScript general utilities", "homepage": "https://community.sap.com/topics/cloud-sdk", "license": "Apache-2.0", diff --git a/test-packages/integration-tests/package-lock.json b/test-packages/integration-tests/package-lock.json index 9c1d2a0a16..ada0b05d6a 100644 --- a/test-packages/integration-tests/package-lock.json +++ b/test-packages/integration-tests/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/integration-tests", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/test-packages/integration-tests/package.json b/test-packages/integration-tests/package.json index 8f817ef5b8..89efd74042 100644 --- a/test-packages/integration-tests/package.json +++ b/test-packages/integration-tests/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/integration-tests", - "version": "1.20.1", + "version": "1.21.0", "description": "SAP Cloud SDK for JavaScript integration tests", "homepage": "https://www.sap.com/cloud-sdk", "license": "Apache-2.0", @@ -13,11 +13,11 @@ "test:watch-debug": "node --inspect-brk node_modules/.bin/jest --watch --runInBand --config ./jest-local.json" }, "dependencies": { - "@sap-cloud-sdk/analytics": "^1.20.1", - "@sap-cloud-sdk/core": "^1.20.1", - "@sap-cloud-sdk/test-services": "^1.20.1", - "@sap-cloud-sdk/test-util": "^1.20.1", - "@sap-cloud-sdk/util": "^1.20.1" + "@sap-cloud-sdk/analytics": "^1.21.0", + "@sap-cloud-sdk/core": "^1.21.0", + "@sap-cloud-sdk/test-services": "^1.21.0", + "@sap-cloud-sdk/test-util": "^1.21.0", + "@sap-cloud-sdk/util": "^1.21.0" }, "devDependencies": { "@types/http-proxy": "^1.17.4", diff --git a/test-packages/test-services/package-lock.json b/test-packages/test-services/package-lock.json index 12fe0a3c84..366042d144 100644 --- a/test-packages/test-services/package-lock.json +++ b/test-packages/test-services/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/test-packages/test-services/package.json b/test-packages/test-services/package.json index b96f113765..cae376c6ef 100644 --- a/test-packages/test-services/package.json +++ b/test-packages/test-services/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services", - "version": "1.20.1", + "version": "1.21.0", "description": "Custom Services for testing", "files": [ "srv/**/*.js", @@ -16,7 +16,7 @@ }, "license": "Apache-2.0", "dependencies": { - "@sap-cloud-sdk/core": "^1.20.1", + "@sap-cloud-sdk/core": "^1.21.0", "bignumber.js": "8.1.1", "moment": "2.24.0" } diff --git a/test-packages/type-tests/package-lock.json b/test-packages/type-tests/package-lock.json index 4fd8f5ec3e..a95f5dd29b 100644 --- a/test-packages/type-tests/package-lock.json +++ b/test-packages/type-tests/package-lock.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/type-tests", - "version": "1.20.1", + "version": "1.21.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/test-packages/type-tests/package.json b/test-packages/type-tests/package.json index 024d47fafe..18c515d94b 100644 --- a/test-packages/type-tests/package.json +++ b/test-packages/type-tests/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/type-tests", - "version": "1.20.1", + "version": "1.21.0", "description": "Tests to ensure correct types in the SAP Cloud SDK for JavaScript.", "homepage": "https://www.sap.com/cloud-sdk", "license": "Apache-2.0", @@ -11,8 +11,8 @@ "test": "npx dtslint test --expectOnly --localTs ../../node_modules/typescript/lib" }, "dependencies": { - "@sap-cloud-sdk/core": "^1.20.1", - "@sap-cloud-sdk/test-services": "^1.20.1" + "@sap-cloud-sdk/core": "^1.21.0", + "@sap-cloud-sdk/test-services": "^1.21.0" }, "devDependencies": { "dtslint": "^3.3.0" diff --git a/typedoc.json b/typedoc.json index 9f26b8fd9b..75eda0d9ff 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { "mode": "modules", - "out": "docs/api/1.20.1", + "out": "docs/api/1.21.0", "exclude": [ "**/index.ts", "scripts/*.ts",