@sequelize/core/lib/utils/format.d.ts

Sequelize is a promise-based Node.js ORM tool for Postgres, MySQL, MariaDB, SQLite, Microsoft SQL Server, Amazon Redshift, Snowflake’s Data Cloud, Db2, and IBM i. It features solid transaction support, relations, eager and lazy loading, read replication a

import type { Attributes, Model, ModelStatic, NormalizedAttributeOptions, WhereOptions } from '..';
export type FinderOptions<TAttributes> = {
    attributes?: string[];
    where?: WhereOptions<TAttributes>;
};
export type MappedFinderOptions<TAttributes> = Omit<FinderOptions<TAttributes>, 'attributes'> & {
    attributes?: Array<[columnName: string, attributeName: string] | string>;
};
/**
 * Expand and normalize finder options.
 * Mutates the "options" parameter.
 *
 * @param options
 * @param Model
 */
export declare function mapFinderOptions<M extends Model, T extends FinderOptions<Attributes<M>>>(options: T, Model: ModelStatic<M>): MappedFinderOptions<Attributes<M>>;
/**
 * Used to map field names in attributes
 *
 * Mutates the "options" parameter.
 *
 * ⚠️ This function does not map the "where" or "having" options, this is handled by QueryGenerator's WHERE generation.
 *
 * @param options
 * @param Model
 */
export declare function mapOptionFieldNames<M extends Model>(options: FinderOptions<Attributes<M>>, Model: ModelStatic): MappedFinderOptions<Attributes<M>>;
/**
 * Used to map field names in values
 *
 * @param dataValues
 * @param attributeNames
 * @param ModelClass
 */
export declare function mapValueFieldNames(// TODO: rename to mapAttributesToColumNames? See https://github.com/sequelize/meetings/issues/17
dataValues: Record<string, any>, attributeNames: Iterable<string>, ModelClass: ModelStatic): Record<string, any>;
/**
 * Removes entries from `hash` whose value is either null or undefined, unless `omitNull` is false or `allowNull` includes that key.
 *
 * Keys ending with 'Id' are never removed.
 *
 * @param hash the object from which entries with nullish values will be removed.
 * @param omitNull if false, this method returns the object as-is
 * @param options
 * @param options.allowNull A list of keys that must be preserved even if their value is null or undefined.
 */
export declare function removeNullishValuesFromHash(hash: Record<string, any>, omitNull: boolean, options?: {
    allowNull?: string[];
}): Record<string, any>;
export declare function getColumnName(attribute: NormalizedAttributeOptions): string;
export declare function getAttributeName(model: ModelStatic, columnName: string): string | null;