numeric.d.cts 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. import type { ColumnBuilderBaseConfig } from "../../column-builder.cjs";
  2. import type { ColumnBaseConfig } from "../../column.cjs";
  3. import { entityKind } from "../../entity.cjs";
  4. import type { AnyPgTable } from "../table.cjs";
  5. import { type Equal } from "../../utils.cjs";
  6. import { PgColumn, PgColumnBuilder } from "./common.cjs";
  7. export type PgNumericBuilderInitial<TName extends string> = PgNumericBuilder<{
  8. name: TName;
  9. dataType: 'string';
  10. columnType: 'PgNumeric';
  11. data: string;
  12. driverParam: string;
  13. enumValues: undefined;
  14. }>;
  15. export declare class PgNumericBuilder<T extends ColumnBuilderBaseConfig<'string', 'PgNumeric'>> extends PgColumnBuilder<T, {
  16. precision: number | undefined;
  17. scale: number | undefined;
  18. }> {
  19. static readonly [entityKind]: string;
  20. constructor(name: T['name'], precision?: number, scale?: number);
  21. }
  22. export declare class PgNumeric<T extends ColumnBaseConfig<'string', 'PgNumeric'>> extends PgColumn<T> {
  23. static readonly [entityKind]: string;
  24. readonly precision: number | undefined;
  25. readonly scale: number | undefined;
  26. constructor(table: AnyPgTable<{
  27. name: T['tableName'];
  28. }>, config: PgNumericBuilder<T>['config']);
  29. mapFromDriverValue(value: unknown): string;
  30. getSQLType(): string;
  31. }
  32. export type PgNumericNumberBuilderInitial<TName extends string> = PgNumericNumberBuilder<{
  33. name: TName;
  34. dataType: 'number';
  35. columnType: 'PgNumericNumber';
  36. data: number;
  37. driverParam: string;
  38. enumValues: undefined;
  39. }>;
  40. export declare class PgNumericNumberBuilder<T extends ColumnBuilderBaseConfig<'number', 'PgNumericNumber'>> extends PgColumnBuilder<T, {
  41. precision: number | undefined;
  42. scale: number | undefined;
  43. }> {
  44. static readonly [entityKind]: string;
  45. constructor(name: T['name'], precision?: number, scale?: number);
  46. }
  47. export declare class PgNumericNumber<T extends ColumnBaseConfig<'number', 'PgNumericNumber'>> extends PgColumn<T> {
  48. static readonly [entityKind]: string;
  49. readonly precision: number | undefined;
  50. readonly scale: number | undefined;
  51. constructor(table: AnyPgTable<{
  52. name: T['tableName'];
  53. }>, config: PgNumericNumberBuilder<T>['config']);
  54. mapFromDriverValue(value: unknown): number;
  55. mapToDriverValue: StringConstructor;
  56. getSQLType(): string;
  57. }
  58. export type PgNumericBigIntBuilderInitial<TName extends string> = PgNumericBigIntBuilder<{
  59. name: TName;
  60. dataType: 'bigint';
  61. columnType: 'PgNumericBigInt';
  62. data: bigint;
  63. driverParam: string;
  64. enumValues: undefined;
  65. }>;
  66. export declare class PgNumericBigIntBuilder<T extends ColumnBuilderBaseConfig<'bigint', 'PgNumericBigInt'>> extends PgColumnBuilder<T, {
  67. precision: number | undefined;
  68. scale: number | undefined;
  69. }> {
  70. static readonly [entityKind]: string;
  71. constructor(name: T['name'], precision?: number, scale?: number);
  72. }
  73. export declare class PgNumericBigInt<T extends ColumnBaseConfig<'bigint', 'PgNumericBigInt'>> extends PgColumn<T> {
  74. static readonly [entityKind]: string;
  75. readonly precision: number | undefined;
  76. readonly scale: number | undefined;
  77. constructor(table: AnyPgTable<{
  78. name: T['tableName'];
  79. }>, config: PgNumericBigIntBuilder<T>['config']);
  80. mapFromDriverValue: BigIntConstructor;
  81. mapToDriverValue: StringConstructor;
  82. getSQLType(): string;
  83. }
  84. export type PgNumericConfig<T extends 'string' | 'number' | 'bigint' = 'string' | 'number' | 'bigint'> = {
  85. precision: number;
  86. scale?: number;
  87. mode?: T;
  88. } | {
  89. precision?: number;
  90. scale: number;
  91. mode?: T;
  92. } | {
  93. precision?: number;
  94. scale?: number;
  95. mode: T;
  96. };
  97. export declare function numeric<TMode extends 'string' | 'number' | 'bigint'>(config?: PgNumericConfig<TMode>): Equal<TMode, 'number'> extends true ? PgNumericNumberBuilderInitial<''> : Equal<TMode, 'bigint'> extends true ? PgNumericBigIntBuilderInitial<''> : PgNumericBuilderInitial<''>;
  98. export declare function numeric<TName extends string, TMode extends 'string' | 'number' | 'bigint'>(name: TName, config?: PgNumericConfig<TMode>): Equal<TMode, 'number'> extends true ? PgNumericNumberBuilderInitial<TName> : Equal<TMode, 'bigint'> extends true ? PgNumericBigIntBuilderInitial<TName> : PgNumericBuilderInitial<TName>;
  99. export declare const decimal: typeof numeric;