char.d.ts 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. import type { ColumnBuilderBaseConfig } from "../../column-builder.js";
  2. import type { ColumnBaseConfig } from "../../column.js";
  3. import { entityKind } from "../../entity.js";
  4. import { type Writable } from "../../utils.js";
  5. import { PgColumn, PgColumnBuilder } from "./common.js";
  6. export type PgCharBuilderInitial<TName extends string, TEnum extends [string, ...string[]], TLength extends number | undefined> = PgCharBuilder<{
  7. name: TName;
  8. dataType: 'string';
  9. columnType: 'PgChar';
  10. data: TEnum[number];
  11. enumValues: TEnum;
  12. driverParam: string;
  13. length: TLength;
  14. }>;
  15. export declare class PgCharBuilder<T extends ColumnBuilderBaseConfig<'string', 'PgChar'> & {
  16. length?: number | undefined;
  17. }> extends PgColumnBuilder<T, {
  18. length: T['length'];
  19. enumValues: T['enumValues'];
  20. }, {
  21. length: T['length'];
  22. }> {
  23. static readonly [entityKind]: string;
  24. constructor(name: T['name'], config: PgCharConfig<T['enumValues'], T['length']>);
  25. }
  26. export declare class PgChar<T extends ColumnBaseConfig<'string', 'PgChar'> & {
  27. length?: number | undefined;
  28. }> extends PgColumn<T, {
  29. length: T['length'];
  30. enumValues: T['enumValues'];
  31. }, {
  32. length: T['length'];
  33. }> {
  34. static readonly [entityKind]: string;
  35. readonly length: T["length"];
  36. readonly enumValues: T["enumValues"];
  37. getSQLType(): string;
  38. }
  39. export interface PgCharConfig<TEnum extends readonly string[] | string[] | undefined = readonly string[] | string[] | undefined, TLength extends number | undefined = number | undefined> {
  40. enum?: TEnum;
  41. length?: TLength;
  42. }
  43. export declare function char(): PgCharBuilderInitial<'', [string, ...string[]], undefined>;
  44. export declare function char<U extends string, T extends Readonly<[U, ...U[]]>, L extends number | undefined>(config?: PgCharConfig<T | Writable<T>, L>): PgCharBuilderInitial<'', Writable<T>, L>;
  45. export declare function char<TName extends string, U extends string, T extends Readonly<[U, ...U[]]>, L extends number | undefined>(name: TName, config?: PgCharConfig<T | Writable<T>, L>): PgCharBuilderInitial<TName, Writable<T>, L>;