enum.d.cts 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. import type { ColumnBuilderBaseConfig } from "../../column-builder.cjs";
  2. import type { ColumnBaseConfig } from "../../column.cjs";
  3. import { entityKind } from "../../entity.cjs";
  4. import type { NonArray, Writable } from "../../utils.cjs";
  5. import { MySqlColumn, MySqlColumnBuilder } from "./common.cjs";
  6. export type MySqlEnumColumnBuilderInitial<TName extends string, TEnum extends string[]> = MySqlEnumColumnBuilder<{
  7. name: TName;
  8. dataType: 'string';
  9. columnType: 'MySqlEnumColumn';
  10. data: TEnum[number];
  11. driverParam: string;
  12. enumValues: TEnum;
  13. }>;
  14. export declare class MySqlEnumColumnBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlEnumColumn'>> extends MySqlColumnBuilder<T, {
  15. enumValues: T['enumValues'];
  16. }> {
  17. static readonly [entityKind]: string;
  18. constructor(name: T['name'], values: T['enumValues']);
  19. }
  20. export declare class MySqlEnumColumn<T extends ColumnBaseConfig<'string', 'MySqlEnumColumn'>> extends MySqlColumn<T, {
  21. enumValues: T['enumValues'];
  22. }> {
  23. static readonly [entityKind]: string;
  24. readonly enumValues: T["enumValues"];
  25. getSQLType(): string;
  26. }
  27. export type MySqlEnumObjectColumnBuilderInitial<TName extends string, TEnum extends object> = MySqlEnumObjectColumnBuilder<{
  28. name: TName;
  29. dataType: 'string';
  30. columnType: 'MySqlEnumObjectColumn';
  31. data: TEnum[keyof TEnum];
  32. driverParam: string;
  33. enumValues: string[];
  34. }>;
  35. export declare class MySqlEnumObjectColumnBuilder<T extends ColumnBuilderBaseConfig<'string', 'MySqlEnumObjectColumn'>> extends MySqlColumnBuilder<T, {
  36. enumValues: T['enumValues'];
  37. }> {
  38. static readonly [entityKind]: string;
  39. constructor(name: T['name'], values: T['enumValues']);
  40. }
  41. export declare class MySqlEnumObjectColumn<T extends ColumnBaseConfig<'string', 'MySqlEnumObjectColumn'>> extends MySqlColumn<T, {
  42. enumValues: T['enumValues'];
  43. }> {
  44. static readonly [entityKind]: string;
  45. readonly enumValues: T["enumValues"];
  46. getSQLType(): string;
  47. }
  48. export declare function mysqlEnum<U extends string, T extends Readonly<[U, ...U[]]>>(values: T | Writable<T>): MySqlEnumColumnBuilderInitial<'', Writable<T>>;
  49. export declare function mysqlEnum<TName extends string, U extends string, T extends Readonly<[U, ...U[]]>>(name: TName, values: T | Writable<T>): MySqlEnumColumnBuilderInitial<TName, Writable<T>>;
  50. export declare function mysqlEnum<E extends Record<string, string>>(enumObj: NonArray<E>): MySqlEnumObjectColumnBuilderInitial<'', E>;
  51. export declare function mysqlEnum<TName extends string, E extends Record<string, string>>(name: TName, values: NonArray<E>): MySqlEnumObjectColumnBuilderInitial<TName, E>;