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

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

import type moment from 'moment';
import type { Field, StringFilterFunction, BooleanFilterFunction, NumberFilterFunction, FilterFunctionPrimitiveParameterType, CollectionField, CollectionFilterFunction, FilterFunctionNames as FilterFunctionNamesCommon, FilterFunctionsType as FilterFunctionsCommonType, Time } from '@sap-cloud-sdk/odata-common/internal';
import type BigNumber from 'bignumber.js';
import type { Entity } from './entity';
import type { DeSerializers } from './de-serializers';
/**
 * Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
 * @param substr - The substring to test for. This can either be a string, a reference to a field or another filter function.
 * @param str - The string to test. This can either be a string, a reference to a field or another filter function.
 * @returns The newly created filter function.
 */
export declare function contains<EntityT extends Entity>(substr: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>): BooleanFilterFunction<EntityT>;
/**
 * Build a filter function to test whether a string matches a pattern. Evaluates to boolean.
 * @param str - The string to get the index from. This can either be a string, a reference to a field or another filter function.
 * @param regex - The pattern to test against. This should be a regular expression as a string.
 * @returns The newly created filter function.
 */
export declare function matchesPattern<EntityT extends Entity>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, regex: string): BooleanFilterFunction<EntityT>;
/**
 * Build a filter function to get the fractional seconds of a date. Evaluates to decimal.
 * @param date - The date to get the fractional seconds for. This can either be a date (Moment) or a reference to a field.
 * @returns The newly created filter function.
 */
export declare function fractionalSeconds<EntityT extends Entity>(date: moment.Moment | Field<EntityT, boolean, boolean>): NumberFilterFunction<EntityT>;
/**
 * Build a filter function to get the signed number of minutes in the time zone offset. Evaluates to int.
 * @param date - The date to get the offset minutes for. This can either be a date (Moment) or a reference to a field.
 * @returns The newly created filter function.
 */
export declare function totalOffsetMinutes<EntityT extends Entity>(date: moment.Moment | Field<EntityT, boolean, boolean>): NumberFilterFunction<EntityT>;
/**
 * Build a filter function to get the latest possible point in time. Evaluates to DateTimeOffset.
 * @returns The newly created filter function.
 */
export declare function maxDateTime<EntityT extends Entity>(): NumberFilterFunction<EntityT>;
/**
 * Build a filter function to get the earliest possible point in time. Evaluates to DateTimeOffset.
 * @returns The newly created filter function.
 */
export declare function minDateTime<EntityT extends Entity>(): NumberFilterFunction<EntityT>;
/**
 * Build a filter function to get the current point in time. Evaluates to DateTimeOffset.
 * @returns The newly created filter function.
 */
export declare function now<EntityT extends Entity>(): NumberFilterFunction<EntityT>;
/**
 * 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.
 * @param subset - The subset to test for. This can either be an array, a reference to a field or another filter function.
 * @param set - The set to test. This can either be an array, a reference to a field or another filter function.
 * @returns The newly created filter function.
 */
export declare function hasSubset<EntityT extends Entity, ParamT extends FilterFunctionPrimitiveParameterType, ReturnT>(subset: ParamT[] | CollectionField<EntityT, any, any, boolean, boolean> | CollectionFilterFunction<EntityT, ReturnT>, set: ParamT[] | CollectionField<EntityT, any, any, boolean, boolean> | CollectionFilterFunction<EntityT, ReturnT>): BooleanFilterFunction<EntityT>;
/**
 * 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.
 * @param subsequence - The subsequence to test for. This can either be an array, a reference to a field or another filter function.
 * @param sequence - The sequence to test. This can either be an array, a reference to a field or another filter function.
 * @returns The newly created filter function.
 */
export declare function hasSubsequence<EntityT extends Entity, ParamT extends FilterFunctionPrimitiveParameterType, ReturnT>(subsequence: ParamT[] | Field<EntityT, boolean, boolean> | CollectionFilterFunction<EntityT, ReturnT>, sequence: ParamT[] | Field<EntityT, boolean, boolean> | CollectionFilterFunction<EntityT, ReturnT>): BooleanFilterFunction<EntityT>;
/**
 * TODO: totalseconds, time.
 */
/**
 * OData v4 specific filter functions.
 * @param deSerializers - DeSerializer used in the filter function.
 * @returns Object containing the filter functions.
 */
export declare function filterFunctions<BinaryT = string, BooleanT = boolean, ByteT = number, DecimalT = BigNumber, DoubleT = number, FloatT = number, Int16T = number, Int32T = number, Int64T = BigNumber, GuidT = string, SByteT = number, SingleT = number, StringT = string, AnyT = any, DateTimeT = moment.Moment, DateTimeOffsetT = moment.Moment, TimeT = Time>(deSerializers?: Partial<DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateTimeT, DateTimeOffsetT, TimeT>>): FilterFunctionTypes;
/**
 * Extending the common filter function by the OData v4 specification for example `contains` or `matchesPattern`.
 */
export type FilterFunctionTypes = FilterFunctionsCommonType & {
    contains: typeof contains;
    matchesPattern: typeof matchesPattern;
    fractionalSeconds: typeof fractionalSeconds;
    totalOffsetMinutes: typeof totalOffsetMinutes;
    maxDateTime: typeof maxDateTime;
    minDateTime: typeof minDateTime;
    now: typeof now;
    hasSubset: typeof hasSubset;
    hasSubsequence: typeof hasSubsequence;
};
/**
 * @internal
 */
export type FilterFunctionNames = FilterFunctionNamesCommon | 'contains' | 'matchesPattern' | 'fractionalSeconds' | 'totalOffsetMinutes' | 'maxDateTime' | 'minDateTime' | 'now' | 'hasSubset' | 'hasSubsequence';