@sap-cloud-sdk/core
Version:
SAP Cloud SDK for JavaScript core
82 lines (56 loc) • 3.67 kB
Markdown
<!-- sap-cloud-sdk-logo -->
<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
<a href="https://sap.com/s4sdk"><img src="https://help.sap.com/doc/2324e9c3b28748a4ae2ad08166d77675/1.0/en-US/logo-with-js.svg" alt="SAP Cloud SDK for JavaScript Logo" height="122.92" width="226.773"/></a>
<!-- sap-cloud-sdk-logo-stop -->
<!-- sap-cloud-sdk-2.0-announcement -->
<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
# Version 2 Release
The SAP Cloud SDK has released version 2.
Check the [upgrade guide](https://sap.github.io/cloud-sdk/docs/js/guides/upgrade-to-version-2) for more details.
Make sure you understand our [release policy](https://sap.github.io/cloud-sdk/docs/js/release-policy).
<!-- sap-cloud-sdk-2.0-announcement-stop -->
# @sap-cloud-sdk/core
This package contains the core functionality of the SAP Cloud SDK as well as the SAP Business Technology 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);
```
For more detailed overview visit our [OData client documentation](https://sap.github.io/cloud-sdk/docs/js/features/odata/use-odata-v2-type-safe-client-for-javascript-typescript).
<!-- sap-cloud-sdk-common-readme -->
<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
## Support
The recommended way to get in touch with us is to create an issue in our [github repository](https://github.com/SAP/cloud-sdk-js/issues).
Select the issue category `Bug`, `Feature` or `Question` depending on the nature of your request.
We try to provide fixes, features and answers as soon as possible.
## Contribute
If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our [contributing guidelines](https://github.com/SAP/cloud-sdk-js/blob/main/CONTRIBUTING.md) and follow the given instructions.
## Links
- [Github](https://github.com/SAP/cloud-sdk-js)
- [Github - Releases](https://github.com/SAP/cloud-sdk-js/releases)
<br>
- [SAP Cloud SDK Documentation portal](https://sap.github.io/cloud-sdk/)
- [SAP Cloud SDK Documentation portal - Getting started guide](https://sap.github.io/cloud-sdk/docs/js/getting-started)
- [SAP Cloud SDK Documentation portal - API documentation](https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts)
<br>
- [developers.sap.com - Product Overview](https://developers.sap.com/topics/cloud-sdk.html)
- [developers.sap.com - Tutorials](https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-cloud-sdk/sap-cloud-sdk&tag=topic:javascript)
## License
The SAP Cloud SDK is released under the [Apache License Version 2.0.](http://www.apache.org/licenses/)
<!-- sap-cloud-sdk-common-readme-stop -->