text.d.ts 1.6 KB

1234567891011121314151617181920212223242526272829303132
  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 PgTextBuilderInitial<TName extends string, TEnum extends [string, ...string[]]> = PgTextBuilder<{
  7. name: TName;
  8. dataType: 'string';
  9. columnType: 'PgText';
  10. data: TEnum[number];
  11. enumValues: TEnum;
  12. driverParam: string;
  13. }>;
  14. export declare class PgTextBuilder<T extends ColumnBuilderBaseConfig<'string', 'PgText'>> extends PgColumnBuilder<T, {
  15. enumValues: T['enumValues'];
  16. }> {
  17. static readonly [entityKind]: string;
  18. constructor(name: T['name'], config: PgTextConfig<T['enumValues']>);
  19. }
  20. export declare class PgText<T extends ColumnBaseConfig<'string', 'PgText'>> extends PgColumn<T, {
  21. enumValues: T['enumValues'];
  22. }> {
  23. static readonly [entityKind]: string;
  24. readonly enumValues: T["enumValues"];
  25. getSQLType(): string;
  26. }
  27. export interface PgTextConfig<TEnum extends readonly string[] | string[] | undefined = readonly string[] | string[] | undefined> {
  28. enum?: TEnum;
  29. }
  30. export declare function text(): PgTextBuilderInitial<'', [string, ...string[]]>;
  31. export declare function text<U extends string, T extends Readonly<[U, ...U[]]>>(config?: PgTextConfig<T | Writable<T>>): PgTextBuilderInitial<'', Writable<T>>;
  32. export declare function text<TName extends string, U extends string, T extends Readonly<[U, ...U[]]>>(name: TName, config?: PgTextConfig<T | Writable<T>>): PgTextBuilderInitial<TName, Writable<T>>;