UNPKG

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