@sap-cloud-sdk/odata-common/dist/filter/filter.d.ts

SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.

import type { DeSerializers } from '../de-serializers';
import type { EdmTypeShared } from '../edm-types';
import type { EntityBase, EntityIdentifiable, ODataVersionOf } from '../entity-base';
import type { FilterFunction } from './filter-function-base';
import type { Filterable } from './filterable';
/**
 * Union type representing all filter operations for string properties like `eq` or `ne`.
 */
export type FilterOperatorString = 'eq' | 'ne' | 'lt' | 'le' | 'gt' | 'ge';
/**
 * Union type representing all filter operations for boolean properties.
 * Possible values are `eq` and `ne`.
 */
export type FilterOperatorBoolean = 'eq' | 'ne';
/**
 * Union type representing all filter operations for number properties like `le` or `gt`.
 */
export type FilterOperatorNumber = 'eq' | 'ne' | 'lt' | 'le' | 'gt' | 'ge';
/**
 * Union type of the filter operators for string, boolean and number types.
 */
export type FilterOperator = FilterOperatorString | FilterOperatorBoolean | FilterOperatorNumber;
/**
 * @internal
 */
export type FilterOperatorByType<FieldT> = FieldT extends string ? FilterOperatorString : FieldT extends number ? FilterOperatorNumber : FilterOperatorBoolean;
/**
 * Represents a filter expression to narrow the data on a {@link GetAllRequestBuilderBase | 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)`.
 * @example `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}.
 * @typeParam EntityT - Type of the entity to be filtered on.
 * @typeParam FieldT - Type of the field to be filtered by.
 */
export declare class Filter<EntityT extends EntityBase, DeSerializersT extends DeSerializers, FieldT> implements EntityIdentifiable<EntityT, DeSerializersT> {
    field: string | FilterFunction<EntityT, FieldT>;
    operator: FilterOperator;
    value: FieldT;
    edmType?: EdmTypeShared<ODataVersionOf<EntityT>> | undefined;
    /**
     * Entity type of the entity tp be filtered.
     */
    readonly _entity: EntityT;
    readonly _deSerializers: DeSerializersT;
    /**
     * Creates an instance of Filter.
     * @param field - Name of the field of the entity to be filtered on or a filter function.
     * @param operator - Function to be used for matching.
     * @param value - Value to be used by the operator.
     * @param edmType - EDM type of the field to filter on, needed for custom fields.
     */
    constructor(field: string | FilterFunction<EntityT, FieldT>, operator: FilterOperator, value: FieldT, edmType?: EdmTypeShared<ODataVersionOf<EntityT>> | undefined);
}
/**
 * Type guard for the `Filter` class.
 * @param filterable - Object to be checked.
 * @returns Whether the given object is of type `Filter`.
 * @internal
 */
export declare function isFilter<EntityT extends EntityBase, DeSerializersT extends DeSerializers, FieldT>(filterable: Filterable<EntityT, DeSerializersT>): filterable is Filter<EntityT, DeSerializersT, FieldT>;