mongo_dottype/dist/mongoDotType.type.d.ts

TypeScript types for using dot notation in mongo queries

import { Expand, FlattenUnion_shallow, objNotNever } from "./extras.type";
import { PickSubs_dotNotation } from "./PickSubs_dotNotation.type";
export declare type defaultDocFields = '_id' | '__v';
export declare type obj_defaultDocFields = {
    _id?: number;
    __v?: number;
};
/**
 * Picks subproperties of the given object with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
export declare type sub<T, arrIndices extends number = never> = PickSubs_dotNotation<Required<FlattenUnion_shallow<T>>, arrIndices>;
/**
 * Picks subproperties of the given object with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 * When `sub` fails with `type instantiation is excessively deep ...` error, this fails silently
 */
export declare type sub_noerror<T, arrIndices extends number = never> = PickSubs_dotNotation<Required<FlattenUnion_shallow<T>>, arrIndices> extends infer U ? U : never;
/**
 * Picks subproperties (& subelements) of 0th level deep (immediate properties)
 * almost an identity type generic
 */
export declare type sublvl0<T, arrIndices extends number = never> = objNotNever<Partial<T>>;
/**
 * Picks subproperties (& subelements) of 1st level deep (subproperties and subelements) with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
export declare type sublvl1<T, arrIndices extends number = never> = objNotNever<sub<T, arrIndices>>;
/**
 * Picks subproperties (& subelements) of 2nd level deep (subsub-properties and -elements) with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
export declare type sublvl2<T, arrIndices extends number = never> = objNotNever<sub<sub<T, arrIndices>, arrIndices>>;
/**
 * Picks subproperties (& subelements) of 3rd level deep (subsubsub-properties and -elements) with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
/** export type sublvl3<T, arrIndices extends number = never> = objNotNever<sub<sublvl2<T, arrIndices>, arrIndices>>; */
/**
 * Picks subproperties (& subelements) of 4th level deep (subsubsubsub-properties and -elements) with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
/** export type sublvl4<T, arrIndices extends number = never> = objNotNever<sub<sublvl3<T, arrIndices>, arrIndices>>; */
/**
 * Picks subproperties (& subelements) of 5th level deep (subsubsubsubsub-properties and -elements) with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
/** export type sublvl5<T, arrIndices extends number = never> = objNotNever<sub<sublvl4<T, arrIndices>, arrIndices>>; */
/**
 * Converts into a type with all properties picked (optionally)
 * almost an identity type generic
 */
export declare type mongoDot_lvl0<T, arrIndices extends number = never> = Expand<FlattenUnion_shallow<obj_defaultDocFields | sublvl0<T, arrIndices>>>;
/**
 * Converts into a type with subproperties and subelements of up to 1 level deep with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
export declare type mongoDot_lvl1<T, arrIndices extends number = never> = Expand<FlattenUnion_shallow<obj_defaultDocFields | sublvl0<T, arrIndices> | sublvl1<T, arrIndices>>>;
/**
 * Converts into a type with subproperties and subelements of up to 2 levels deep with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
export declare type mongoDot_lvl2<T, arrIndices extends number = never> = Expand<FlattenUnion_shallow<obj_defaultDocFields | sublvl0<T, arrIndices> | sublvl1<T, arrIndices> | sublvl2<T, arrIndices>>>;
/**
 * Converts into a type with subproperties and subelements of up to 3 levels deep with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
/** export type mongoDot_lvl3<T, arrIndices extends number = never> = Expand<FlattenUnion_shallow<obj_defaultDocFields | sublvl0<T, arrIndices> | sublvl1<T, arrIndices> | sublvl2<T, arrIndices> | sublvl3<T, arrIndices>>>; */
/**
 * Converts into a type with subproperties and subelements of up to 4 levels deep with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
/** export type mongoDot_lvl4<T, arrIndices extends number = never> = Expand<FlattenUnion_shallow<obj_defaultDocFields | sublvl0<T, arrIndices> | sublvl1<T, arrIndices> | sublvl2<T, arrIndices> | sublvl3<T, arrIndices> | sublvl4<T, arrIndices>>>; */
/**
 * Converts into a type with subproperties and subelements of up to 5 levels deep with dot notation
 * If `arrIndices` is provided, uses all these indices to pick elements of array properties of the given object with dot notation
 */
/** export type mongoDot_lvl5<T, arrIndices extends number = never> = Expand<FlattenUnion_shallow<obj_defaultDocFields | sublvl0<T, arrIndices> | sublvl1<T, arrIndices> | sublvl2<T, arrIndices> | sublvl3<T, arrIndices> | sublvl4<T, arrIndices> | sublvl5<T, arrIndices>>>; */