Celestine API Documentation - v0.2.0
    Preparing search index...

    Interface TransitSearchResult

    Result of searching transits in a date range.

    interface TransitSearchResult {
        params: TransitSearchParams;
        transits: TransitTiming[];
        houseIngresses?: HouseIngress[];
        byMonth: Record<string, TransitTiming[]>;
        summary: {
            totalTransits: number;
            byAspect: Partial<Record<AspectType, number>>;
            byBody: Record<string, number>;
            dateRange: { start: TransitDate; end: TransitDate; days: number };
        };
    }
    Index

    Properties

    params transits houseIngresses? byMonth summary

    Properties

    params: TransitSearchParams

    Search parameters used

    transits: TransitTiming[]

    All transit timings found, sorted by first exact date

    houseIngresses?: HouseIngress[]

    House ingresses found (if enabled)

    byMonth: Record<string, TransitTiming[]>

    Transits grouped by month (YYYY-MM key)

    summary: {
        totalTransits: number;
        byAspect: Partial<Record<AspectType, number>>;
        byBody: Record<string, number>;
        dateRange: { start: TransitDate; end: TransitDate; days: number };
    }

    Summary statistics

    Type Declaration

    • totalTransits: number

      Total transits found

    • byAspect: Partial<Record<AspectType, number>>

      Transit count by aspect type

    • byBody: Record<string, number>

      Transit count by transiting body

    • dateRange: { start: TransitDate; end: TransitDate; days: number }

      Date range covered

    Settings

    Member Visibility

    On This Page

    Properties