@timescaledb/schemas/dist/candlestick.d.ts

This package contains Zod schemas and types for all TimescaleDB objects.

import { z } from 'zod';
export declare const CandlestickAggregateOptionsSchema: z.ZodObject<{
    price_column: z.ZodString;
    time_column: z.ZodOptional<z.ZodString>;
    volume_column: z.ZodOptional<z.ZodString>;
    bucket_interval: z.ZodDefault<z.ZodOptional<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
    price_column: string;
    bucket_interval: string;
    time_column?: string | undefined;
    volume_column?: string | undefined;
}, {
    price_column: string;
    time_column?: string | undefined;
    volume_column?: string | undefined;
    bucket_interval?: string | undefined;
}>;
export type CandlestickAggregateOptions = z.infer<typeof CandlestickAggregateOptionsSchema>;
export declare const CandlesticksResultSchema: z.ZodObject<{
    bucket_time: z.ZodDate;
    open: z.ZodNumber;
    high: z.ZodNumber;
    low: z.ZodNumber;
    close: z.ZodNumber;
    volume: z.ZodOptional<z.ZodNumber>;
    vwap: z.ZodOptional<z.ZodNumber>;
    open_time: z.ZodDate;
    high_time: z.ZodDate;
    low_time: z.ZodDate;
    close_time: z.ZodDate;
}, "strip", z.ZodTypeAny, {
    bucket_time: Date;
    open: number;
    high: number;
    low: number;
    close: number;
    open_time: Date;
    high_time: Date;
    low_time: Date;
    close_time: Date;
    volume?: number | undefined;
    vwap?: number | undefined;
}, {
    bucket_time: Date;
    open: number;
    high: number;
    low: number;
    close: number;
    open_time: Date;
    high_time: Date;
    low_time: Date;
    close_time: Date;
    volume?: number | undefined;
    vwap?: number | undefined;
}>;
export type CandlesticksResult = z.infer<typeof CandlesticksResultSchema>;
export type Candlestick = Omit<CandlesticksResult, 'bucket_time'>;
export type GetCandlesticksOptions = z.infer<typeof GetCandlesticksOptionsSchema>;
export declare const GetCandlesticksOptionsSchema: z.ZodObject<{
    timeRange: z.ZodObject<{
        start: z.ZodDate;
        end: z.ZodDate;
    }, "strip", z.ZodTypeAny, {
        start: Date;
        end: Date;
    }, {
        start: Date;
        end: Date;
    }>;
    config: z.ZodObject<{
        price_column: z.ZodString;
        time_column: z.ZodOptional<z.ZodString>;
        volume_column: z.ZodOptional<z.ZodString>;
        bucket_interval: z.ZodDefault<z.ZodOptional<z.ZodString>>;
    }, "strip", z.ZodTypeAny, {
        price_column: string;
        bucket_interval: string;
        time_column?: string | undefined;
        volume_column?: string | undefined;
    }, {
        price_column: string;
        time_column?: string | undefined;
        volume_column?: string | undefined;
        bucket_interval?: string | undefined;
    }>;
    where: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodDate, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodDate]>, "many">]>, z.ZodRecord<z.ZodEnum<["=", ">", "<", ">=", "<=", "IN", "NOT IN"]>, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodDate, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodDate]>, "many">]>>]>>>;
}, "strip", z.ZodTypeAny, {
    timeRange: {
        start: Date;
        end: Date;
    };
    config: {
        price_column: string;
        bucket_interval: string;
        time_column?: string | undefined;
        volume_column?: string | undefined;
    };
    where?: Record<string, string | number | Date | (string | number | Date)[] | Partial<Record<"=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN", string | number | Date | (string | number | Date)[]>>> | undefined;
}, {
    timeRange: {
        start: Date;
        end: Date;
    };
    config: {
        price_column: string;
        time_column?: string | undefined;
        volume_column?: string | undefined;
        bucket_interval?: string | undefined;
    };
    where?: Record<string, string | number | Date | (string | number | Date)[] | Partial<Record<"=" | ">" | "<" | ">=" | "<=" | "IN" | "NOT IN", string | number | Date | (string | number | Date)[]>>> | undefined;
}>;
export declare const CandlestickColumnOptionsSchema: z.ZodObject<{
    time_column: z.ZodOptional<z.ZodString>;
    price_column: z.ZodString;
    volume_column: z.ZodString;
    source_column: z.ZodString;
}, "strip", z.ZodTypeAny, {
    price_column: string;
    volume_column: string;
    source_column: string;
    time_column?: string | undefined;
}, {
    price_column: string;
    volume_column: string;
    source_column: string;
    time_column?: string | undefined;
}>;
export type CandlestickColumnOptions = z.infer<typeof CandlestickColumnOptionsSchema>;