@compas/code-gen
Version:
Generate various boring parts of your server
52 lines (51 loc) • 2.01 kB
TypeScript
/**
* Run through all object expansion types.
*
* - Extends existing types via `extend`
* - Replaces `pick` and `omit` with their evaluated object
*
* @param {import("../generate").GenerateContext} generateContext
*/
export function objectExpansionExecute(
generateContext: import("../generate").GenerateContext,
): void;
/**
* Extend named objects for each 'extend' in the structure.
*
* The 'extend' type is then removed from the structure, as it doesn't serve a purpose
* anymore.
*
* @param {import("../generated/common/types").ExperimentalStructure} structure
* @param {import("../generated/common/types").ExperimentalTypeDefinition} namedType
*/
export function objectExpansionExtend(
structure: import("../generated/common/types").ExperimentalStructure,
namedType: import("../generated/common/types").ExperimentalTypeDefinition,
): void;
/**
* Replace 'omit' types with an object definition without the omitted keys.
*
* This function alters the type in place, creating a shallow copy of the source objects
* keys.
*
* @param {import("../generated/common/types").ExperimentalStructure} structure
* @param {import("../generated/common/types").ExperimentalTypeDefinition} namedType
*/
export function objectExpansionOmit(
structure: import("../generated/common/types").ExperimentalStructure,
namedType: import("../generated/common/types").ExperimentalTypeDefinition,
): void;
/**
* Replace 'pick' types with an object definition only including the picked keys
*
* This function alters the type in place, creating a shallow copy of the source objects
* keys.
*
* @param {import("../generated/common/types").ExperimentalStructure} structure
* @param {import("../generated/common/types").ExperimentalTypeDefinition} namedType
*/
export function objectExpansionPick(
structure: import("../generated/common/types").ExperimentalStructure,
namedType: import("../generated/common/types").ExperimentalTypeDefinition,
): void;
//# sourceMappingURL=object-expansion.d.ts.map