UNPKG

3.21 kBMarkdownView Raw
1<!-- sap-cloud-sdk-logo -->
2<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
3<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>
4<!-- sap-cloud-sdk-logo-stop -->
5
6# @sap-cloud-sdk/core
7
8This package contains the core functionality of the SAP Cloud SDK as well as the SAP Business Technology Platform abstractions.
9
10## Installation
11
12```
13$ npm install @sap-cloud-sdk/core
14```
15
16## Usage
17
18The core is the heart of the SAP Cloud SDK and contains the functionality that is essential to every project powered by the SDK.
19Any OData client built by the SAP Cloud SDK, be it the VDM or clients built by the generator are using the core.
20We recommend to install this in addition to your clients.
21
22Below is an example showing how you can build and execute your request with multiple filters by using an function called `and`.
23
24```
25import { and } from '@sap-cloud-sdk/core';
26import { BusinessPartner } from '@sap/cloud-sdk-vdm-business-partner-service';
27
28// Build your filters
29const firstNameFilter = BusinessPartner.FIRST_NAME.equals('firstName');
30const lastNameFilter = BusinessPartner.LAST_NAME.equals('lastName');
31
32// Execute your request with two filters
33BusinessPartner.requestBuilder()
34 .getAll()
35 .filter(and(firstNameFilter, lastNameFilter))
36 .execute(yourDestination);
37```
38
39For 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).
40
41<!-- sap-cloud-sdk-common-readme -->
42<!-- This block is inserted by scripts/replace-common-readme.ts. Do not adjust it manually. -->
43## Support
44
45The 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).
46Select the issue category `Bug`, `Feature` or `Question` depending on the nature of your request.
47We try to provide fixes, features and answers as soon as possible.
48
49## Contribute
50
51If 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.
52
53## Links
54
55- [Github](https://github.com/SAP/cloud-sdk-js)
56- [Github - Releases](https://github.com/SAP/cloud-sdk-js/releases)
57
58<br>
59
60- [SAP Cloud SDK Documentation portal](https://sap.github.io/cloud-sdk/)
61- [SAP Cloud SDK Documentation portal - Getting started guide](https://sap.github.io/cloud-sdk/docs/js/getting-started)
62- [SAP Cloud SDK Documentation portal - API documentation](https://sap.github.io/cloud-sdk/docs/js/api-reference-js-ts)
63
64<br>
65
66- [developers.sap.com - Product Overview](https://developers.sap.com/topics/cloud-sdk.html)
67- [developers.sap.com - Tutorials](https://developers.sap.com/tutorial-navigator.html?tag=products:technology-platform/sap-cloud-sdk/sap-cloud-sdk&tag=topic:javascript)
68
69## License
70
71The SAP Cloud SDK is released under the [Apache License Version 2.0.](http://www.apache.org/licenses/)
72<!-- sap-cloud-sdk-common-readme-stop -->