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

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

import type { EntityBase, Constructable } from '../entity-base';
/**
 * Optional settings for fields.
 */
export interface FieldOptions<NullableT extends boolean = false, SelectableT extends boolean = false> {
    /**
     * Whether the value of the field can be `null`.
     */
    isNullable?: NullableT;
    /**
     * Whether the field can be reference in a `.select` statement.
     */
    isSelectable?: SelectableT;
    /**
     * Precision associated with field.
     */
    precision?: number;
}
/**
 * Get field options merged with default values.
 * The given options take precedence.
 * @param fieldOptions - Given options.
 * @returns Given options merged with default values.
 * @internal
 */
export declare function getFieldOptions<NullableT extends boolean = false, SelectableT extends boolean = false>(fieldOptions?: FieldOptions<NullableT, SelectableT>): Required<FieldOptions<NullableT, SelectableT>>;
/**
 * Abstract representation a property of an OData entity.
 *
 * `Field`s are used as static properties of entities or properties of {@link ComplexTypeField}s 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.
 *
 * See also: {@link Selectable}, {@link EdmTypeField}, {@link ComplexTypeField}.
 * @typeParam EntityT - Type of the entity the field belongs to.
 * @typeParam NullableT - Boolean type that represents whether the field is nullable.
 * @typeParam SelectableT - Boolean type that represents whether the field is selectable.
 */
export declare class Field<EntityT extends EntityBase, NullableT extends boolean = false, SelectableT extends boolean = false> {
    readonly _fieldName: string;
    readonly _entityConstructor: Constructable<EntityT>;
    readonly _fieldOptions: Required<FieldOptions<NullableT, SelectableT>>;
    /**
     * Creates an instance of Field.
     * @param _fieldName - Actual name of the field used in the OData request.
     * @param _entityConstructor - Constructor type of the entity the field belongs to.
     * @param fieldOptions - Optional settings for this field.
     */
    constructor(_fieldName: string, _entityConstructor: Constructable<EntityT>, fieldOptions?: FieldOptions<NullableT, SelectableT>);
    /**
     * Path to the field to be used in filter and order by queries.
     * @returns Path to the field to be used in filter and order by queries.
     */
    fieldPath(): string;
}