Readonly selectableRepresentation of a batch change set, which holds a collection of write operations.
+Representation of a batch change set, which holds a collection of write operations.
Requests to combine to one change set.
Optional boundary: stringRequest boundary for separation of sub requests. Defaults to an auto generated value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly boundaryReadonly requestsReadonly boundaryReadonly requestsRepresentation of a filter function, that returns a value of type boolean.
+Representation of a filter function, that returns a value of type boolean.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a field of an entity or a complex type, that can have a collection as value.
+Represents a field of an entity or a complex type, that can have a collection as value.
Type of the entity the field belongs to.
Type of the (de-)serializers.
Type of of elements of the collection. This can either be an EDM type or complex type.
@@ -20,4 +20,4 @@Readonly _deReadonly _entityReadonly _fieldReadonly _fieldReadonly _fieldReadonly _fieldRepresentation of a filter function, that returns a collection of values.
+Representation of a filter function, that returns a collection of values.
Abstract Represents a complex type property of an entity or a complex type.
+Abstract Represents a complex type property of an entity or a complex type.
ComplexTypeFields are used as static properties of entities and are generated from the metadata, i.e. for each property of
an OData entity, that has a complex type, there exists one static instance of ComplexTypeField (or rather one of its subclasses) in the corresponding generated class file.
ComplexTypeFields are used to represent the domain of complex or custom structures that can be used in select, filter and order by functions.
@@ -31,4 +31,4 @@
Readonly deReadonly fieldCreate an OData request to count entities based on the configuration of the request. +
Create an OData request to count entities based on the configuration of the request.
A CountRequestBuilder allows only for execution of the request.
If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.
Type of the entity to be requested
@@ -55,4 +55,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract Abstract create request class holding the parts shared in OData v2 and v4.
+Abstract Abstract create request class holding the parts shared in OData v2 and v4.
Type of the entity to be created
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
If your entity contains fields not present in your service specification you can model them using custom fields. +
If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.
Optional isNullable: NullableTReadonly _entityReadonly _fieldReadonly _fieldProtected fieldAbstract Abstract class to delete an entity holding the shared parts between OData v2 and v4.
+Abstract Abstract class to delete an entity holding the shared parts between OData v2 and v4.
Type of the entity to be deleted
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a property of an OData entity with an EDM type.
+Represents a property of an OData entity with an EDM type.
EdmTypeFields are used as static properties of entities or EDM typed fields of complex type fields. They are generated from the OData metadata, i.e. for each property of
an OData entity, that has an EDM type, there is one static instance of EdmTypeField (or rather one of its subclasses) in the corresponding generated class file.
EdmTypeFields are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions.
@@ -38,4 +38,4 @@
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract Super class for all representations of OData entity types.
+Abstract Super class for all representations of OData entity types.
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Contains the methods to build an entity.
+Contains the methods to build an entity.
The custom fields you want to add.
The entity builder itself for method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a property with an enum value.
+Represents a property with an enum value.
Type of the entity the field belongs to.
Enum type that contains all valid enum entries for this field.
Boolean type that represents whether the field is nullable.
@@ -27,4 +27,4 @@Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract representation a property of an OData entity.
+Abstract representation a property of an OData entity.
Fields are used as static properties of entities or properties of ComplexTypeFields and are generated from the metadata, i.e. for each property of
an OData entity, there exists one static instance of Field (or rather one of its subclasses) in the corresponding generated class file.
Fields are used to represent the domain of values that can be used in select, filter and order by functions.
Readonly _entityReadonly _fieldReadonly _fieldField builder to orchestrate the creation of the different kinds of fields.
+Field builder to orchestrate the creation of the different kinds of fields.
Type of the entity or complex type field this field belongs to.
Type of the (de-)serializers.
Whether the field is nullable.
A collection field with the given collection type.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria. +
Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria.
A filter refers to the field of an entity and restricts the request based on an operator and a value. Entity.FIELD_NAME.operator(value).
`Product.NAME.equals('cloud-sdk')` creates a filter for the entity `Product` that matches in case the field `NAME` equals 'cloud-sdk'.
See also: {@link Filterable}.
Readonly _deDummy property to also include the deserializer type in the structure of the entity type.
Readonly _entityEntity type of the entity tp be filtered.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Optional edmOptional edmAbstract Data structure to represent OData filter functions. +
Abstract Data structure to represent OData filter functions.
Use the factory function filterFunction to create instances of FilterFunction.
Class representing a filter expression based on a FilterLambdaOperator.
+Class representing a filter expression based on a FilterLambdaOperator.
Data structure to represent filter on properties of a navigation property (link). +
Data structure to represent filter on properties of a navigation property (link). In OData v2 filtering for navigation properties is ONLY supported for properties with a one-to-one cardinality (OneToOneLink).
In the following filter statement `Entity.requestBuilder().filter(Entity.to_NavProperty.filter(LinkedEntity.property.equals(value)))`,
`Entity.to_NavProperty.filter(LinkedEntity.property.equals(value))` is a `FilterLink`.
In OData v4 filtering is also possible on one-to-many links. See {@link OneToManyLink}.
Type of the linked entity which is used in
Readonly _entityEntity type of the entity tp be filtered.
Readonly _linkedLinked entity to be filtered by.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Data structure to combine Filterables conjunctively and / or disjunctively. A FilterList matches when all filterables within the andFilters match and when at least one filterable within the orFilters matches. Should not be used directly.
Data structure to combine Filterables conjunctively and / or disjunctively. A FilterList matches when all filterables within the andFilters match and when at least one filterable within the orFilters matches. Should not be used directly.
Dummy property to also include the deserializer type in the structure of the entity type.
Readonly _entityEntity type of the entity tp be filtered.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.
+Abstract Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.
Type of the entity to be requested
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.
+Abstract Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.
Type of the entity to be requested
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a navigation property of an OData entity.
+Represents a navigation property of an OData entity.
OData is a relational data model, i.e. entities can be related to one another. For example, BusinessPartner is in a 1:n relation with BusinessPartnerAddress and in a 1:1 relation with Customer. Like normal properties, navigation properties can be used for selecting (expanding) and filtering. @@ -35,4 +35,4 @@
Rest ...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
The link itself, to facilitate method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.
+Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
OData batch request configuration for an entity type.
+OData batch request configuration for an entity type.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependOData count request configuration for an entity type.
+OData count request configuration for an entity type.
Type of the entity to setup a request for
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependOData create request configuration for an entity type.
+OData create request configuration for an entity type.
Type of the entity to setup a request for
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected resourceProtected prependProtected resourceOData delete request configuration for an entity type.
+OData delete request configuration for an entity type.
Type of the entity to setup a request for
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependAbstract Function request configuration for an entity type.
+Abstract Function request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependAbstract queryAbstract resourceProtected prependAbstract queryAbstract resourceOData getAll request configuration for an entity type.
+OData getAll request configuration for an entity type.
Type of the entity to setup a request for
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependOData getByKey request configuration for an entity type.
+OData getByKey request configuration for an entity type.
Type of the entity to setup a request for
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependOData request configuration for an entity type.
+OData request configuration for an entity type.
Type of the entity to setup a request for.
Abstract Parent class for all OData request configs like getAll, delete or count.
Abstract Parent class for all OData request configs like getAll, delete or count.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependAbstract queryAbstract resourceProtected prependAbstract queryAbstract resourceOData update request configuration for an entity type.
+OData update request configuration for an entity type.
Type of the entity to setup a request for
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependRepresents a one to many relation for OData v4 entities. +
Maximum number of entities to return in the response. Can be less, if less entities match the request.
The request builder itself, to facilitate method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents a link from one entity to one other linked entity (as opposed to a list of linked entities). In OData v2 a OneToOneLink can be used to filter and order a selection on an entity based on filters and orders on a linked entity.
Represents a link from one entity to one other linked entity (as opposed to a list of linked entities). In OData v2 a OneToOneLink can be used to filter and order a selection on an entity based on filters and orders on a linked entity.
Type of the entity to be linked to.
Type of the entity to be linked from
Rest ...selects: Selectable<EntityType<LinkedEntityApiT>, DeSerializersT>[]Selection of fields or links on a linked entity.
The link itself, to facilitate method chaining.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Internal representation of operation parameters. It adds metadata to the value.
+Internal representation of operation parameters. It adds metadata to the value.
Original EDM type.
Value to be used as parameter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract Create OData request to execute an action or function.
+Abstract Create OData request to execute an action or function.
Type of the (de-)serializers.
Type of the function return value.
Type of the request config.
@@ -65,4 +65,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
OData queries take this to determine the order of results.
+OData queries take this to determine the order of results.
Readonly _deDummy property to also include the deserializer type in the structure of the entity type.
Readonly _entityDummy property whose type makes structurally identical entities distinguishable in TypeScript.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly _entityReadonly _entityLink to represent an order by on a linked entity.
+Link to represent an order by on a linked entity.
Type of the entity to link to.
Type of the entity to link from.
Link to the entity to order by.
A list of orderables based on the linked entity.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Readonly entityReadonly linkedReadonly entityReadonly linkedEdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.
EdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.
Type of the entity the field belongs to.
EDM type of the field.
Boolean type that represents whether the field is nullable.
@@ -47,4 +47,4 @@Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Abstract Represents a request builder for a given entity API.
+Abstract Represents a request builder for a given entity API.
Dummy property to also include the deserializer type in the structure of the entity type.
Dummy property whose type makes structurally identical entities distinguishable in TypeScript.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Representation of a filter function, that returns a value of type string.
+Representation of a filter function, that returns a value of type string.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Class representing a unary filter which is a filter containing just a single argument e.g. not.
+Class representing a unary filter which is a filter containing just a single argument e.g. not.
Abstract Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.
+Abstract Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.
Type of the entity to be updated
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an OData request to count entities based on the configuration of the request. +
Create an OData request to count entities based on the configuration of the request.
A CountRequestBuilder allows only for execution of the request.
If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.
Type of the entity to be requested.
@@ -56,4 +56,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create OData request to create an entity.
+Create OData request to create an entity.
Type of the entity to be created.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
If your entity contains fields not present in your service specification you can model them using custom fields. +
If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.
Optional isNullable: NullableTReadonly _entityReadonly _fieldReadonly _fieldProtected fieldCreate OData query to delete an entity.
+Create OData query to delete an entity.
Type of the entity to be deleted.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Super class for all representations of OData v2 entity types.
-Super class for all representations of OData v2 entity types.
+Protected _customA mapper representing custom fields in an entity. +
Protected _customA 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 _entityReadonly _oProtected _versionThe current ETag version of the entity in the remote system. +
Readonly _entityReadonly _oProtected _versionThe 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 remoteThe remote state of the entity. @@ -77,4 +77,4 @@
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents an object that is related to an entity. +
Represents an object that is related to an entity. Objects that have the same structure would be represented by the same type in TypeScript. This interface allows to identify equal structures as different structures if they are related to different entities.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an OData request to get a single entity based on its key properties. +
Create an OData request to get a single entity based on its key properties. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields. Note that navigational properties are automatically expanded if they included in a select.
Type of the entity to be requested.
@@ -73,4 +73,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. The retrieve and change sets will be executed in order, while the order within a change set can vary.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Function request configuration for an entity type.
+Function request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependCreate OData request to execute an operation. +
Create OData request to execute an operation. For v2, only function, but not action, is supported.
Type of the function import parameters.
Type of the function import return value.
@@ -68,4 +68,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create OData query to update an entity.
+Create OData query to update an entity.
Type of the entity to be updated.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Since 3.3.0. Use OperationParameter instead.
+Since 3.3.0. Use OperationParameter instead.
Original EDM type.
Value to be used as parameter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Since 3.3.0. Use OperationRequestBuilder instead.
+Since 3.3.0. Use OperationRequestBuilder instead.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Since 3.3.0. Use OperationRequestBuilder instead.
+Since 3.3.0. Use OperationRequestBuilder instead.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Since 3.3.0. Use OperationRequestBuilder instead.
+Since 3.3.0. Use OperationRequestBuilder instead.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create bound OData request to execute an operation.
+Create bound OData request to execute an operation.
Type of the operation parameters.
Type of the operation return value.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an OData request to count entities based on the configuration of the request. +
Create an OData request to count entities based on the configuration of the request.
A CountRequestBuilder allows only for execution of the request.
If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.
Type of the entity to be requested.
@@ -56,4 +56,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create OData request to create an entity.
+Create OData request to create an entity.
Type of the entity to be created.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
If your entity contains fields not present in your service specification you can model them using custom fields. +
If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.
Optional isNullable: NullableTReadonly _entityReadonly _fieldReadonly _fieldProtected fieldRepresentation of a filter function, that returns a value of type date. This supports DateTimeOffset values.
+Representation of a filter function, that returns a value of type date. This supports DateTimeOffset values.
Value to be used in the filter.
The resulting filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create OData query to delete an entity.
+Create OData query to delete an entity.
Type of the entity to be deleted.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Super class for all representations of OData v4 entity types.
-Super class for all representations of OData v4 entity types.
+Protected _customA mapper representing custom fields in an entity. +
Protected _customA 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 _entityReadonly _oProtected _versionThe current ETag version of the entity in the remote system. +
Readonly _entityReadonly _oProtected _versionThe 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 remoteThe remote state of the entity. @@ -77,4 +77,4 @@
Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.
An object containing all instance variables + custom fields.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Since 3.3.0. Use OperationRequestBuilder instead.
+Since 3.3.0. Use OperationRequestBuilder instead.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents an object that is related to an entity. +
Represents an object that is related to an entity. Objects that have the same structure would be represented by the same type in TypeScript. This interface allows to identify equal structures as different structures if they are related to different entities.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an OData request to get a single entity based on its key properties. +
Create an OData request to get a single entity based on its key properties. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields of the entity. Navigational properties need to be expanded explicitly by GetAllRequestBuilder.expand. Where no selection is equal to selecting all fields.
@@ -75,4 +75,4 @@Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Action request configuration for an entity type.
+Action request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependCreate a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. The retrieve and change sets will be executed in order, while the order within a change set can vary.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Since 3.3.0. Use ODataBoundActionRequestConfig instead.
+Since 3.3.0. Use ODataBoundActionRequestConfig instead.
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependAction request configuration for an entity type.
+Action request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependFunction request configuration for an entity type.
+Function request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependFunction request configuration for an entity type.
+Function request configuration for an entity type.
Type of the deserializer use on the request
Type of the parameter to setup a request with
Add custom request configuration to the request.
Key-value pairs where the key is the name of a request configuration and the value is the respective value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Protected prependProtected prependCreate OData request to execute an operation.
+Create OData request to execute an operation.
Type of the operation parameters.
Type of the operation return value.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create OData query to update an entity.
+Create OData query to update an entity.
Type of the entity to be updated.
Destination or DestinationFetchOptions to execute the request against.
Promise resolving to the URL for the request.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Request builder for OpenAPI requests.
+Request builder for OpenAPI requests.
Create an instance of OpenApiRequestBuilder.
HTTP method of the request to be built.
@@ -29,7 +30,9 @@Set middleware for requests towards the target system given in the destination.
Middlewares to be applied to the executeHttpRequest().
The request builder itself, to facilitate method chaining.
-Rest ...middlewares: HttpMiddleware[]Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Rest ...middlewares: HttpMiddleware[]Protected requestGet http request config.
+Promise of http request config with origin.
+Represents an error that was caused by another error.
-Represents an error that was caused by another error.
+Create an instance of ErrorWithCause.
Error message.
Original error, causing this error.
-Readonly causeOriginal error, causing this error.
-Optional stackStatic Optional prepareOptional override for formatting stack traces
+Readonly causeOriginal error, causing this error.
+Optional stackStatic Optional prepareOptional override for formatting stack traces
Static stackRoot cause of the error. If there are multiple errors caused one by another, the root cause is the first error that occurred. In case there is no root cause.
The root cause.
-Static captureOptional constructorOpt: FunctionHolds state on already used names and provides new names if there are naming conflicts.
+Holds state on already used names and provides new names if there are naming conflicts.
if `MyName` and `MyName_1MySuffix` is already taken, `[MyName_2, MyName_2MySuffix]` will be generated by default.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Constraints the selection to provider destinations.
+Constraints the selection to provider destinations.
Retrieved destinations.
Name of the destination to retrieve.
The destination to retrieve, returns null, if no matched provider destination is found.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Constraints the selection to subscriber destinations.
+Constraints the selection to subscriber destinations.
Retrieved destinations.
Name of the destination to retrieve.
The destination to retrieve, returns null, if no matched subscriber destination is found.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Assertion that the Destination is a HttpDestination. +
Assertion that the Destination is a HttpDestination. This method comes in handy when you retrieved a destination from the destination service and need to check if it is a HttpDestination.
Destination or HttpDestination.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a request header object, that contains authentication headers and SAP specific headers like 'sap-client', from a given destination.
+Build a request header object, that contains authentication headers and SAP specific headers like 'sap-client', from a given destination.
The given destination that contains e.g., authentication and SAP client information.
A request header object, built from the given destination.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Decode JWT.
+Decode JWT.
JWT to be decoded.
Decoded payload.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Tries to build a destination from a service binding with the given name. +
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.
The name of the service.
@@ -6,4 +6,4 @@A destination.
Since v3.4.0. Use getDestinationFromServiceBinding instead.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Returns the http or https-agent config depending on the destination URL. +
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.
Determining which kind of configuration is returned.
The HTTP or HTTPS agent configuration.
Temporarily replaced by getAgentConfigAsync, will change its default behavior to be asynchronous in next major release.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Will be renamed to getAgentConfig in the next major release. +
Will be renamed to getAgentConfig in the next major release. Returns a promise of 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.
Determining which kind of configuration is returned.
A promise of the HTTP or HTTPS agent configuration.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Fetches all destinations from the destination service which match the token. +
Fetches all destinations from the destination service which match the token. With a subscriber token it fetches all subscriber destinations, otherwise all provider destinations.
Optional options: AllDestinationOptionsThe options to fetch all destinations.
A promise of an array of all destinations without authTokens from the destination service, on success.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Make a client credentials request against the XSUAA service.
+Make a client credentials request against the XSUAA service.
Service as it is defined in the environment variable.
Optional jwt: string | JwtPayloadUser JWT or object containing the iss property.
Client credentials token.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Builds a destination from one of three sources (in the given order):
+Builds a destination from one of three sources (in the given order):
The options to retrieve the destination.
A promise returning the requested destination on success.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Retrieves a destination with the given name from the Cloud Foundry destination service. +
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.
Configuration for how to retrieve destinations from the destination service.
A promise returning the requested destination on success.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Tries to build a destination from a service binding with the given name. +
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.
Options to customize the behavior of this function.
A destination.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Returns the first found instance for the given service type. +
Returns the first found instance for the given service type. Internally uses xsenv library to read configurations from VCAP_SERVICES.
The service type.
The first found service.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Get the tenant ID of a decoded JWT, based on its zid or if not available app_tid property.
Get the tenant ID of a decoded JWT, based on its zid or if not available app_tid property.
Token to read the tenant ID from.
The tenant ID, if available.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Make a user token request against the XSUAA service.
+Make a user token request against the XSUAA service.
Service as it is defined in the environment variable.
User JWT.
User token.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Type guard to find if object is a Destination.
+Type guard to find if object is a Destination.
Destination to be checked.
Boolean.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Returns a jwt bearer token that can be used to call the given service. +
Returns a JWT bearer token that can be used to call the given service. The token is fetched via a JWT bearer token grant using the user token + client credentials.
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.
A jwt bearer token.
+A JWT bearer token.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Takes a JSON object returned by any of the calls to the destination service and returns an SDK compatible destination object. +
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. TODO: deprecated: Remove from public api in version 4. (Check if related types can also be removed from public api).
A JSON object returned by the destination service.
An SDK compatible destination object.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
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. +
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.
Environment variable which is parsed.
Configuration with default values or undefined if the parsing failed.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Registers a destination in a cache for later usage.
+Registers a destination in a cache for later usage.
If a destination with the same key is already in the cache, it is replaced.
The key is built using the getDestinationCacheKey method.
A destination to add to the destinations cache.
Optional options: RegisterDestinationOptionsOptions how to cache the destination.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
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
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
Request to retrieve the JWT from.
JWT found in header.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Takes an existing or a parsed destination and returns an SDK compatible destination object.
+Takes an existing or a parsed destination and returns an SDK compatible destination object.
An object that adheres to the Destination interface.
An SDK compatible destination object.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
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. +
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.
@@ -7,4 +7,4 @@Optional options: CachingOptions & { Options to influence caching behavior (see CachingOptions) and a JWT. By default, caching and usage of a circuit breaker are enabled.
Access token.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Sets the custom destination cache instance. +
Sets the custom destination cache instance. Call this method with an instance of DestinationCacheInterface to override the default cache instance set by the SDK.
NOTE: This function should be called at the beginning before any calls to either getDestination or @sap-cloud-sdk/http-client!executeHttpRequest.
An instance of DestinationCacheInterface.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Prioritizes the selection of subscriber destinations.
+Prioritizes the selection of subscriber destinations.
Retrieved destinations.
Name of the destination to retrieve.
The destination to retrieve, returns null if no matched destination is found.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform destination to string containing destination information.
+Transform destination to string containing destination information.
Either destination object or destinationName and Jwt.
String containing information on the destination.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Convenience function to create a destination from the provided service binding. +
Convenience function to create a destination from the provided service binding. If a JWT is provided as part of options, the tenant in the JWT is used for client credentials grant, else the provider tenant is used, wherever applicable. Supported service types are:
Optional options: ServiceBindingTransformOptionsOptions used for fetching the destination.
A promise returning the transformed destination on success.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Returns the parameter if it is a destination, calls getDestination otherwise (which will try to fetch the destination +
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 destination or the necessary parameters to fetch one.
A promise resolving to the requested destination on success.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Main entry point for the OData client generation. +
Main entry point for the OData client generation. Generates models and API files.
Options to configure generation.
A promise to void.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Builds a DestinationHttpRequestConfig for the given destination. +
Builds a DestinationHttpRequestConfig for the given destination. If a destination name (and a JWT) are provided, it will try to resolve the destination.
A destination or a destination name and a JWT.
A DestinationHttpRequestConfig.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Middleware for fetching a CSRF token. This middleware is added to all request per default. +
Middleware for fetching a CSRF token. This middleware is added to all request per default.
Use the fetchCsrfToken option to disable it.
Optional options: CsrfMiddlewareOptionsOptions like URL or method to configure the token fetching.
The middleware for fetching CSRF tokens.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Encoder for encoding all query parameters (key and value) using encodeURIComponent.
+Encoder for encoding all query parameters (key and value) using encodeURIComponent.
Parameter to be encoded using encodeURIComponent.
Encoded parameter object.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Builds a DestinationHttpRequestConfig for the given destination, merges it into the given requestConfig and executes it (using Axios).
Builds a DestinationHttpRequestConfig for the given destination, merges it into the given requestConfig and executes it (using Axios).
A destination or a destination name and a JWT.
Optional requestConfig: TAny object representing an HTTP request.
Optional options: HttpRequestOptionsAn HttpRequestOptions of the HTTP request for configuring e.g., CSRF token delegation. By default, the SDK will fetch the CSRF token.
A promise resolving to an HttpResponse.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Builds a DestinationHttpRequestConfig for the given destination, merges it into the given HttpRequestConfigWithOrigin +
Builds a DestinationHttpRequestConfig for the given destination, merges it into the given HttpRequestConfigWithOrigin and executes it (using Axios). The HttpRequestConfigWithOrigin supports defining header options and query parameter options with origins. Equally named headers and query parameters are prioritized in the following order:
@@ -13,4 +13,4 @@A promise resolving to an HttpResponse.
https://sap.github.io/cloud-sdk/docs/js/features/connectivity/query-parameters
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Sends e-mails to a target mail server defined in a given destination. +
Sends e-mails to a target mail server defined in a given destination.
Builds a transport between the application and the mail server, sends mails sequentially by using the transport, then closes it.
This function also does the destination look up, when passing DestinationOrFetchOptions.
A destination or a destination name and a JWT.
@@ -7,4 +7,4 @@A promise resolving to an array of MailResponse.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Combine Filterables with logical and to create a FilterList.
Combine Filterables with logical and to create a FilterList.
Type of the entity filter on.
Filterables to be combined with logical and.
The newly created FilterList.
@@ -8,4 +8,4 @@Entity.requestBuilder()
.getAll()
.filter(filterExp1, filterExp2);
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Rest ...expressions: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>[]Rest ...expressions: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>[]Create new Order by orderBy._fieldName in ascending order.
Create new Order by orderBy._fieldName in ascending order.
Type of the entity to be ordered
Field or link to be ordered by.
New order.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create new Order by orderBy._fieldName in descending order.
Create new Order by orderBy._fieldName in descending order.
Type of the entity to be ordered
Field or link to be ordered by.
New order.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an entity builder for an entity API.
+Create an entity builder for an entity API.
The entity API to build entities for.
An entity builder instance for the given entity API.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Constructs an entityDeserializer given the OData v2 or v4 specific methods. +
Constructs an entityDeserializer given the OData v2 or v4 specific methods. The concrete deserializers are created in odata/v2/entity-deserializer.ts and odata/v4/entity-deserializer.ts.
(De-)serializers used for transformation.
Extractor for the ETag.
Extractor for data related to one to many links.
An entity deserializer as defined by EntityDeserializer.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Constructs an entitySerializer given the OData v2 or v4 specific tsToEdm method. +
Constructs an entitySerializer given the OData v2 or v4 specific tsToEdm method. The concrete serializers are created in odata/v2/entity-serializer.ts and odata/v4/entity-serializer.ts.
(De-)serializers used for transformation.
A entity serializer as defined by EntitySerializer.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]Rest ...parameters: FilterFunctionParameterType<EntityT>[]Rest ...parameters: FilterFunctionParameterType<EntityT>[]Rest ...parameters: FilterFunctionParameterType<EntityT>[]Rest ...parameters: FilterFunctionParameterType<EntityT>[]Rest ...parameters: FilterFunctionParameterType<EntityT>[]Convenience function to check whether a given EDM type is of type OrderableEdmType.
+Convenience function to check whether a given EDM type is of type OrderableEdmType.
Literal EDM type string to check.
Whether the given edmType is of type OrderableEdmType.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Negate a filter.
+Negate a filter.
The filter to negate.
The negated filter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Combine Filterables with logical or to create a FilterList.
Combine Filterables with logical or to create a FilterList.
Type of the entity filter on.
Filterables to be combined with logical or.
The newly created FilterList.
Entity.requestBuilder()
.getAll()
.filter(or(filterExp1, filterExp2));
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Rest ...expressions: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>[]Rest ...expressions: Filterable<EntityT, DeSerializersT, EntityApi<EntityBase, any>>[]We want to provide methods which accept a variable single number of elements and arrays. +
We want to provide methods which accept a variable single number of elements and arrays. The overloaded signature to achieve this is:
function doSomething(array: T[])
function doSomething(...varArgs: T[])
function doSomething(first: undefined | T | T[], ...rest: T[]) {
//implementation
}
Second to last element, if var args were used, empty array, if the first argument is an array.
Array from the input or empty array if no input was given.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Convert a value from EDM format to TypeScript. This function is typically used when deserializing an OData response.
+Convert a value from EDM format to TypeScript. This function is typically used when deserializing an OData response.
The original value with EDM format.
The EDM type of that value.
(De-)serializers used for transformation.
Deserialized value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Entity deserializer instance for v2 entities. +
Entity deserializer instance for v2 entities. See @sap-cloud-sdk/odata-common!EntityDeserializer for the provided methods.
DeSerializer.
EntityDeserializer.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
OData v2 specific filter functions.
+OData v2 specific filter functions.
Filter functions object.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Export length filter function for backwards compatibility.
+Export length filter function for backwards compatibility.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Get a complete set of (de-)serializers, that consists of the given partial custom (de-)serializers and default (de-)serializers (aka. default (de-)serializers merged with custom (de-)serializers). +
Get a complete set of (de-)serializers, that consists of the given partial custom (de-)serializers and default (de-)serializers (aka. default (de-)serializers merged with custom (de-)serializers). The custom (de-)serializers are merged with the default (de-)serializers, while custom (de-)serializers take precedence.
A full set of (de-)serialization functions, that combines custom and default (de-)serializers.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to replace the occurrence of a search string with another string. Evaluates to string.
+Build a filter function to replace the occurrence of a search string with another string. Evaluates to string.
The string to get the index from. This can either be a string, a reference to a field or another filter function.
The substring to get the index for. This can either be a string, a reference to a field or another filter function.
The substring to get the index for. This can either be a string, a reference to a field or another filter function.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Export substring filter function for backwards compatibility.
+Export substring filter function for backwards compatibility.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Optional len: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>Optional len: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
+Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
The substring to test for. This can either be a string, a reference to a field or another filter function.
The string to test. This can either be a string, a reference to a field or another filter function.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to a complex type by using given deserialization function.
+Transform the payload of the OData response to a complex type by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to complex type array by using given deserialization function.
+Transform the payload of the OData response to complex type array by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to edm type by using given deserialization function.
+Transform the payload of the OData response to edm type by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to edm type array by using given deserialization function.
+Transform the payload of the OData response to edm type array by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of an OData response to an entity by using the given (de-)serializers.
+Transform the payload of an OData response to an entity by using the given (de-)serializers.
The OData payload.
Entity API that holds the (de-)serializers.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to array of entities by using given (de-)serializers.
+Transform the payload of the OData response to array of entities by using given (de-)serializers.
The OData payload.
Entity API that holds the (de-)serializers.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to undefined. +
Transform the payload of the OData response to undefined. This function is used in function imports, when no values need to be returned.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Will return the entity if all elements of the one-to-many link relation fulfill the condition.
+Will return the entity if all elements of the one-to-many link relation fulfill the condition.
Rest ...filters: Filterable<EntityT, DeSerializersT, LinkedEntityApiT>[]A filter condition like MyEntity.someMultiLink.someProperty.eq('value').
The lambda filter function to be considered in the query.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Will return the entity if at least one element of the one-to-many link relation fulfills the condition.
+Will return the entity if at least one element of the one-to-many link relation fulfills the condition.
Rest ...filters: Filterable<EntityT, DeSerializersT, LinkedEntityApiT>[]A filter condition like MyEntity.someMultiLink.someProperty.eq('value').
The lambda filter function to be considered in the query.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
+Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
The substring to test for. This can either be a string, a reference to a field or another filter function.
The string to test. This can either be a string, a reference to a field or another filter function.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Convert a value with edm format to one with typescript format. This function is typically used when deserializing an OData response.
+Convert a value with edm format to one with typescript format. This function is typically used when deserializing an OData response.
The original value with edm format.
The edm type of that value.
(De-)serializers used for transformation.
Deserialized value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Entity deserializer instance for v4 entities. +
Entity deserializer instance for v4 entities. See @sap-cloud-sdk/odata-common!EntityDeserializer for the provided methods.
DeSerializer to be used.
EntityDeserializer.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
-Build a custom filter function.
+Build a custom filter function.
The name of the function, e.g., substring.
The return type of the filter function.
Rest ...parameters: FilterFunctionParameterType<EntityT>[]The parameter(s) used in the function.
An instance of filter function suited for the given return type.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
OData v4 specific filter functions.
+OData v4 specific filter functions.
Object containing the filter functions.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to get the fractional seconds of a date. Evaluates to decimal.
+Build a filter function to get the fractional seconds of a date. Evaluates to decimal.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to test whether a set is a subsequence of the other, i.e. whether the second parameter can be transformed into the first by removing items. Evaluates to boolean.
+Build a filter function to test whether a set is a subsequence of the other, i.e. whether the second parameter can be transformed into the first by removing items. Evaluates to boolean.
The subsequence to test for. This can either be an array, a reference to a field or another filter function.
The sequence to test. This can either be an array, a reference to a field or another filter function.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to test whether a set is a subset of the other, i.e. whether the second parameter can be transformed into the first by reordering and / or removing items. Evaluates to boolean.
+Build a filter function to test whether a set is a subset of the other, i.e. whether the second parameter can be transformed into the first by reordering and / or removing items. Evaluates to boolean.
The subset to test for. This can either be an array, a reference to a field or another filter function.
The set to test. This can either be an array, a reference to a field or another filter function.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to test whether a string matches a pattern. Evaluates to boolean.
+Build a filter function to test whether a string matches a pattern. Evaluates to boolean.
The string to get the index from. This can either be a string, a reference to a field or another filter function.
The pattern to test against. This should be a regular expression as a string.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to get the latest possible point in time. Evaluates to DateTimeOffset.
+Build a filter function to get the latest possible point in time. Evaluates to DateTimeOffset.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Get a complete set of (de-)serializers, that consists of the given partial custom (de-)serializers and default (de-)serializers (aka. default (de-)serializers merged with custom (de-)serializers). +
Get a complete set of (de-)serializers, that consists of the given partial custom (de-)serializers and default (de-)serializers (aka. default (de-)serializers merged with custom (de-)serializers). The custom (de-)serializers are merged with the default (de-)serializers, while custom (de-)serializers take precedence.
A full set of (de-)serialization functions, that combines custom and default (de-)serializers.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to get the earliest possible point in time. Evaluates to DateTimeOffset.
+Build a filter function to get the earliest possible point in time. Evaluates to DateTimeOffset.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to get the current point in time. Evaluates to DateTimeOffset.
+Build a filter function to get the current point in time. Evaluates to DateTimeOffset.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Build a filter function to get the signed number of minutes in the time zone offset. Evaluates to int.
+Build a filter function to get the signed number of minutes in the time zone offset. Evaluates to int.
The newly created filter function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to a complex type by using given deserialization function.
+Transform the payload of the OData response to a complex type by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to complex type array by using given deserialization function.
+Transform the payload of the OData response to complex type array by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to edm type by using given deserialization function.
+Transform the payload of the OData response to edm type by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to edm type array by using given deserialization function.
+Transform the payload of the OData response to edm type array by using given deserialization function.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of an OData response to an entity by using the given (de-)serializers.
+Transform the payload of an OData response to an entity by using the given (de-)serializers.
The OData payload.
Entity API that holds the (de-)serializers.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to array of entities by using given (de-)serializers.
+Transform the payload of the OData response to array of entities by using given (de-)serializers.
The OData payload.
Entity API that holds the (de-)serializers.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Transform the payload of the OData response to undefined. +
Transform the payload of the OData response to undefined. This function is used in function imports, when no values need to be returned.
The transformed value.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Main entry point for the OpenAPI client generation. +
Main entry point for the OpenAPI client generation. Generates models and API files.
Options to configure generation.
A promise to void.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Helper method to build a circuit breaker middleware.
+Helper method to build a circuit breaker middleware.
The middleware adding a circuit breaker to the function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
The middleware adding a circuit breaker to the function.
+The middleware adding a circuit breaker to the function.
Since v3.0.1. Use {@link circuitBreaker} instead.
Helper method to build a circuit breaker middleware.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Return the resilience middleware functions as an array. +
Return the resilience middleware functions as an array. By default, timeout and circuit breaker are enabled and retry is disabled. This behavior can be overridden by adjusting the resilience options ResilienceOptions.
Optional options: ResilienceOptionsResilience Options.
Array of middleware functions.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Helper method to build a retry middleware.
+Helper method to build a retry middleware.
Optional retries: numberNumber of retry attempts. Default value is 3.
The middleware adding a retry to the function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Helper method to build a timeout middleware.
+Helper method to build a timeout middleware.
Optional timeoutValue: numberTimeout in milliseconds. Default value is 10000.
The middleware adding a timeout to the function.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Loads a destination matching the provided alias stored in systems.json and credentials.json.
+
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.
Optional options: GetTestDestinationOptionsReferences to the systems.json and credentials.json files.
An array of destinations.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Loads all destinations stored in systems.json and credentials.json files.
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.
@@ -7,4 +7,4 @@Optional options: GetTestDestinationOptionsReferences to the systems.json and credentials.json files.
An array of destinations.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Add all destinations from the systems.json and credentials.json files to the destinations environment variable.
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.
Optional options: GetTestDestinationOptionsReferences to the systems.json and credentials.json files.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Add a destination with the given name from the systems.json and credentials.json files to the destinations environment variable.
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.
Name of the test destination to add to the destinations environment variable.
Optional options: GetTestDestinationOptionsReferences to the systems.json and credentials.json files.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Set a given destination in the destinations environment variable.
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.
Test destination to add to the destinations environment variable.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Removes all test destinations stored in systems.json and credentials.json files or added through setTestDestination() from the destinations environment variable.
Removes all test destinations stored in systems.json and credentials.json files or added through setTestDestination() from the destinations environment variable.
This function should be called to invert the behavior of mockAllTestDestinations() and other add single mocked destination functions.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
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. +
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().
Name of the mocked destination to remove.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Adds a key value pair to the given objects and returns a shallow copy. +
Adds a key value pair to the given objects and returns a shallow copy. If the key is already present it will be overwritten.
Key to be added.
Value to be added.
@@ -6,4 +6,4 @@The object with the key value pair added.
Since v3.12.1. Will not be replaced.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Experimental This API is experimental and might change in newer versions. Use with caution. +
Experimental This API is experimental and might change in newer versions. Use with caution. Transform strings and arguments to a string formatted as a code block, keeping the indentation of sub code blocks. Use in tagged templates, e.g.:
codeBlock`Code with ${arguments} and more code;`
@@ -7,4 +7,4 @@
Rest ...args: any[]Arguments in the tagged template. In the example above that would be the resolved value for arguments;.
A string formatted as code block.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a logger for the given message context, if available.
+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.
@@ -14,4 +14,4 @@
Optional messageContext: string | MessageContextObj & LoggerOptionsEither a key for the message context of all messages produced by the logger or an object with additional keys to set in the message.
A newly created or an already existing logger for the given context.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Experimental This API is experimental and might change in newer versions. Use with caution. +
Experimental This API is experimental and might change in newer versions. Use with caution. Transform strings and arguments to a string formatted as a documentation block. The formatting is block like so no leading or trailing spaces. New lines in the beginning and end are also removed. @@ -9,4 +9,4 @@
Rest ...args: string[]Arguments in the tagged template. In the example above that would be the resolved value for arguments;.
A string formatted as documentation block.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Checks whether the two items contain the same content. +
Checks whether the two items contain the same content. When both of them are arrays, the elements and the order are checked, see equalArrays. When both of them are objects, the key/value pairs are checked, see equalObjects. In other cases, triple equals is used.
@@ -6,4 +6,4 @@The second item.
A boolean, indicating all the items equal to each other.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Checks whether the elements of two arrays are the same with the same order.
+Checks whether the elements of two arrays are the same with the same order.
A boolean, indicating both arrays have the same contents.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Checks whether the keys and values of two objects are equal.
+Checks whether the keys and values of two objects are equal.
The first object.
The second object.
A boolean, indicating whether the two objects are equal to each other.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a shallow copy of the given object, that does not contain the given keys. +
Create a shallow copy of the given object, that does not contain the given keys. Non existing keys in the source object are ignored.
Properties to be selected.
Object from which the values are taken.
An object with the selected keys and corresponding values.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Filter an array by removing duplicates and keeping the left most occurrence. By default this compares by identity.
+Filter an array by removing duplicates and keeping the left most occurrence. By default this compares by identity.
Array to remove duplicates from.
Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.
A filtered array containing no duplicates.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Filter an array by removing duplicates and keeping the right most occurrence. By default this compares by identity.
+Filter an array by removing duplicates and keeping the right most occurrence. By default this compares by identity.
Array to remove duplicates from.
Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.
A filtered array containing no duplicates.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Await all promises and resolve if non of them failed. +
Await all promises and resolve if non of them failed. Reject if at least one of them was rejected, but only once all of them are finished. Throws an error consisting of a list of reasons.
Promises to settle.
Optional errorMessage: stringMessage to use as introductory text of the error if an error occurs.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Get the first item from an array. Returns undefined, if the array is empty.
Get the first item from an array. Returns undefined, if the array is empty.
Array to get the first item of.
Fist item of the array or undefined, if the array was empty.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Convert a JSON object to a string using formatting in line with the prettier with indentation and new line at the end.
+Convert a JSON object to a string using formatting in line with the prettier with indentation and new line at the end.
Object to be stringified.
The JSON object as string.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Get logger for a given message context, if available.
+Get logger for a given message context, if available.
Optional messageContext: stringA key for the message context of all messages produced by the logger.
The logger for the given messageContext if it was created before.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Type guard to check whether an error is of type ErrorWithCause.
+Type guard to check whether an error is of type ErrorWithCause.
An error.
Whether the given error is of type ErrorWithCause.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Get the last item from an array. Returns undefined, if the array is empty.
Get the last item from an array. Returns undefined, if the array is empty.
Array to get the last item of.
Last item of the array or undefined, if the array was empty.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Keys present both objects will be present in the merged object.
Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Keys present both objects will be present in the merged object.
right object are replaced. Note that the casing used by right will be used.Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Only keys present in the left object will be present in the merged object.
Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Only keys present in the left object will be present in the merged object.
left object, where entries present in the right object are replaced. Note that the casing used by right will be used.Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Split an array into two based on a condition.
+Split an array into two based on a condition.
A two dimensional array containing two arrays, where the first one includes all items where the given condition was met and the second one includes all items where it was not met.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a shallow copy of the given object, that contains the given keys. +
Create a shallow copy of the given object, that contains the given keys. Non existing keys in the source object are ignored.
Properties to be selected.
Object from which the values are taken.
An object with the selected keys and corresponding values.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a shallow copy of the given object, that contains the given keys, independent of casing. +
Create a shallow copy of the given object, that contains the given keys, independent of casing. Non existing keys in the source object are ignored.
Optional obj: TObject to pick the given key from.
Rest ...keys: string[]Keys of the pair to be picked.
@@ -6,4 +6,4 @@Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create a shallow copy of the given object, that contains all entries with non-nullish values.
+Create a shallow copy of the given object, that contains all entries with non-nullish values.
Optional obj: TAn object to pick from.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Returns the value of an object based on the given key, independent of casing.
+Returns the value of an object based on the given key, independent of casing.
Object to be searched for the given key.
Key of the value to pick.
The value of for the given key or undefined, if not available.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Checks if a chain of properties exists on the given object.
+Checks if a chain of properties exists on the given object.
The object to be checked.
Rest ...properties: string[]Chained properties.
true if the property chain leads to a truthy value, false otherwise.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Remove file extension from a string, e.g. remove 'test.jpg' would return 'test'.
+Remove file extension from a string, e.g. remove 'test.jpg' would return 'test'.
File name to remove the file extension from.
File name without extension.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Takes an object and returns a new object whose keys are renamed according to the provided key mapping. +
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".
An object mapping keys of the input object to keys of the output object.
The input object.
An object with renamed keys.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Potentially sensitive keys will be matched case-insensitive and as substrings. +
Potentially sensitive keys will be matched case-insensitive and as substrings. Matches will be replaced with a placeholder string.
The record to be sanitized.
Optional replacementString: stringThe placeholder string.
Optional sensitiveKeys: string[]The list of keys to be replaced. This overrides the default list.
The sanitized copy of the input record.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Change the global log format of the container which will set default format for all active loggers. +
Change the global log format of the container which will set default format for all active loggers.
e.g., to set the global log format to local call setGlobalLogLevel(logFormat.local) or use a custom log format.
The log format to set the global log format to.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Change the global log level of the container which will set default level for all active loggers. +
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').
The log level to set the global log level to.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Change the global transport of the container which will set default transport for all active loggers. +
Change the global transport of the container which will set default transport for all active loggers.
e.g., to set the global transport call setGlobalTransports(httpTransport).
The transport to set the global transport to. Both single transport and an array with multiple transports are supported.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Change the log format of a logger based on its message context. +
Change the log format of a logger based on its message context.
e.g., to set the log format for the destination accessor module of the SDK to local, simply call setLogFormat(logFormat.local, 'destination-accessor').
Format to set the logger to. Use logFormat to get the pre-defined log formats or use a custom log format.
Optional messageContextOrLogger: string | LoggerMessage context of the logger to change the log level for or the logger itself.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Change the log level of a logger based on its message context. +
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-accessor').
Level to set the logger to. Use an empty string '' as level to unset context level.
Optional messageContextOrLogger: string | LoggerMessage context of the logger to change the log level for or the logger itself.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Split the given array in chunks.
+Split the given array in chunks.
Array to be split into chunks.
Size of the chunks.
Two dimensional array with arrays of length chunkSize. The last subarray could be shorter.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Create an object based on the given key and value if neither key nor value are nullish.
+Create an object based on the given key and value if neither key nor value are nullish.
Name of the header.
Value of the header.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
We want to provide methods which accept a variable single number of elements and arrays. +
We want to provide methods which accept a variable single number of elements and arrays. The overloaded signature to achieve this is:
function doSomething(array: T[])
function doSomething(...varArgs: T[])
function doSomething(first: undefined | T | T[], ...rest: T[]) {
//implementation
}
Second to last element, if var args were used, empty array, if the first argument is an array.
Array from the input or empty array if no input was given.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Convert a string to the uppercase snake case. This format is used e.g. for static properties on entity classes.
+Convert a string to the uppercase snake case. This format is used e.g. for static properties on entity classes.
The string to be transformed.
The input string in the case used by static methods on entity-classes.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Merge two arrays by alternately adding inserting values from both arrays, starting from the left.
+Merge two arrays by alternately adding inserting values from both arrays, starting from the left.
Zipped array.
`zip([1, 2], [3, 4, 5, 6])` results in `[1, 3, 2, 4, 5, 6]`.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
The SAP Cloud SDK for JavaScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Business Technology Platform.
+The SAP Cloud SDK for JavaScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Business Technology Platform.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Collection of all destinations from the provider and subscriber account. +
Collection of all destinations from the provider and subscriber account. The used DestinationSelectionStrategy will decide which destination is selected in the end.
Collection of all destinations from the provider account.
Collection of all destinations from the subscriber account.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Standard proxy configuration without additional headers nor authorization info.
+Standard proxy configuration without additional headers nor authorization info.
Representation of a cached object.
+Options to enable caching when fetching destinations.
+Represents the response to a client credentials request.
+Represents the response to a client credentials request.
A resolved destination containing information needed to execute requests, such as the system URL.
+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 Business Technology Platform (via DestinationFetchOptions). 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.
Optional usernameUsername to use for basic authentication, optional if other means of authentication shall be used.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Options to configure the behavior of the destination accessor.
+Options to configure the behavior of the destination accessor.
Optional selectionMethod that implements the selection strategy of the retrieved destination. Uses subscriberFirst per default. Use the selector helper DestinationSelectionStrategies to select the appropriate selection strategy.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents authentication token returned from destination service.
+Represents authentication token returned from destination service.
Represents a certificate attached to a destination.
+Represents a certificate attached to a destination.
Configuration of a destination as it is available through the destination service.
+Configuration of a destination as it is available through the destination service.
Declaration of a destination to be retrieved from an environment variable or from the destination service on SAP Business Technology Platform, including all DestinationOptions.
+Declaration of a destination to be retrieved from an environment variable or from the destination service on SAP Business Technology Platform, including all DestinationOptions.
Use an object of this interface to specify which destination shall be used when executing a request. The destination will be retrieved via its DestinationFetchOptions.destinationName according to the following algorithm:
Optional cacheThe verification keys are cached if set to true.
-Name of the destination to retrieve, mandatory.
+Name of the destination to retrieve, mandatory.
Optional iasOption to enable/disable the IAS token to XSUAA token exchange.
Optional isolationThe isolation strategy used for caching destinations. For the available options, see IsolationStrategy. By default, 'tenant-user' is set.
@@ -44,4 +44,4 @@Optional selectionMethod 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 useA boolean value that indicates whether to read destinations from cache.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Options to customize the behavior of getDestinationFromServiceBinding.
+Options to customize the behavior of getDestinationFromServiceBinding.
Optional serviceCustom transformation function to control how a Destination is built from the given Service.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Destination configuration alongside auth tokens and certificates.
+Destination configuration alongside auth tokens and certificates.
Optional certificatesCertificates for authentication as they are available through the destination service.
Configuration of a destination as it is available through the destination service.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Collection of all destinations from an account. +
Collection of all destinations from an account. For a given account a destination can originate from the destination service instance or subaccount.
Collection of destinations from the destination service instance.
Collection of destinations from the subaccount.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Interface for the http-agent within the Axios request config.
Interface for the https-agent within the Axios request config.
This is copied from @types/jsonwebtoken.
This is copied from @types/jsonwebtoken.
Optional nbfStandard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.
Optional subStandard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Proxy settings for connecting to an on-premise destination via connectivity proxy or web proxies. +
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 follows:
The protocol used by the proxy.
Optional proxy-A JWT for proxy authorization, which is used when HTTP headers are not applicable, e.g., using socket protocols.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Represents the request headers when using a proxy like the connectivity proxy to reach On-Premise systems.
+Represents the request headers when using a proxy like the connectivity proxy to reach On-Premise systems.
Proxy-Authorization header sent to the proxy.
Optional SAP-SAP-Connectivity-Authentication header sent via the proxy to the target system containing the propagated user.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Unspecific representation of a service as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).
+Unspecific representation of a service as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).
Options to control certain aspects of JWT verification behavior.
-Options to control certain aspects of JWT verification behavior.
+Optional cacheThe verification keys are cached if set to true.
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Options to configure OData client generation when using the generator programmatically.
+Options to configure OData client generation when using the generator programmatically.
Represents the selection of all fields. +
- Preparing search index...
- The search index is not available
SAP Cloud SDK for JavaScript - v3.18.1Class AllFields<EntityT>
Represents the selection of all fields. This field should be used in the schema of entities.
Type Parameters
Index
Constructors
Properties
Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.
Constructors
constructor
Type Parameters
Parameters
Returns AllFields<EntityT>
Properties
_entity
_field
ReadonlyselectableSettings
Member Visibility
Theme
On This Page