js-data-projector/src/project-data.d.ts

import {
  ProjectionSchema,
  ProjectionSchemaName,
  ProjectionSchemaProperties,
} from './projection-schema.js';

/**
 * Projection schema name resolver.
 */
export type ProjectionSchemaNameResolver = (
  schemaName: string,
) => ProjectionSchemaProperties | ProjectionSchemaName;

/**
 * Project data options.
 */
export type ProjectDataOptions = {
  strict?: boolean;
  scope?: string;
  nameResolver?: ProjectionSchemaNameResolver;
  factoryArgs?: unknown[];
};

/**
 * Project data.
 *
 * @param data
 * @param schema
 * @param options
 */
export declare function projectData<T>(
  data: T,
  schema: ProjectionSchema,
  options?: ProjectDataOptions,
): T;