@nestjs/graphql
Version:
Nest - modern, fast, powerful node.js web framework (@graphql)
30 lines • 1.29 kB
TypeScript
/**
* The API surface of this module has been heavily inspired by the "type-graphql" library (https://github.com/MichalLytek/type-graphql), originally designed & released by Michal Lytek.
* In the v6 major release of NestJS, we introduced the code-first approach as a compatibility layer between this package and the `@nestjs/graphql` module.
* Eventually, our team decided to reimplement all the features from scratch due to a lack of flexibility.
* To avoid numerous breaking changes, the public API is backward-compatible and may resemble "type-graphql".
*/
import { EnumMetadataValuesMap } from '../schema-builder/metadata';
/**
* Interface defining options that can be passed to `registerEnumType` function.
*/
export interface EnumOptions<T extends object = any> {
/**
* Name of the enum.
*/
name: string;
/**
* Description of the enum.
*/
description?: string;
/**
* A map of options for the values of the enum.
*/
valuesMap?: EnumMetadataValuesMap<T>;
}
/**
* Registers a GraphqQL enum type based on the passed enumerator reference.
* @param options
*/
export declare function registerEnumType<T extends object = any>(enumRef: T, options?: EnumOptions<T>): void;
//# sourceMappingURL=register-enum-type.factory.d.ts.map