functional-models
    Preparing search index...

    Interface BuilderV2Link

    An in between or ending type to a builder creating a SearchQuery

    interface BuilderV2Link {
        and: () => QueryBuilder;
        compile: () => OrmSearch;
        or: () => QueryBuilder;
        pagination: (
            value: any,
        ) => Readonly<
            {
                compile: () => OrmSearch;
                pagination: (value: any) => Readonly<{ pagination: ...; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
                sort: (
                    key: string,
                    sortOrder?: SortOrder,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                take: (
                    count: number,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2;
        sort: (
            key: string,
            sortOrder?: SortOrder,
        ) => Readonly<
            {
                compile: () => OrmSearch;
                pagination: (
                    value: any,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: ...; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
                take: (
                    count: number,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2;
        take: (
            count: number,
        ) => Readonly<
            {
                compile: () => OrmSearch;
                pagination: (
                    value: any,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                sort: (
                    key: string,
                    sortOrder?: SortOrder,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                take: (count: number) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: ...; compile: () => OrmSearch; }> & Readonly<...>...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2;
    }
    Index

    Properties

    and compile or pagination sort take

    Properties

    and: () => QueryBuilder

    Links together two or more Query or complex queries.

    compile: () => OrmSearch

    Compiles the builder into a search query.

    or: () => QueryBuilder

    Links together two or more Query or complex queries.

    pagination: (
        value: any,
    ) => Readonly<
        {
            compile: () => OrmSearch;
            pagination: (value: any) => Readonly<{ pagination: ...; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
            sort: (
                key: string,
                sortOrder?: SortOrder,
            ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            take: (
                count: number,
            ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
        },
    > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

    Creates a pagination.

    Type declaration

      • (
            value: any,
        ): Readonly<
            {
                compile: () => OrmSearch;
                pagination: (value: any) => Readonly<{ pagination: ...; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
                sort: (
                    key: string,
                    sortOrder?: SortOrder,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                take: (
                    count: number,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

      • Parameters

        • value: any

          Can be anything

        Returns Readonly<
            {
                compile: () => OrmSearch;
                pagination: (value: any) => Readonly<{ pagination: ...; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
                sort: (
                    key: string,
                    sortOrder?: SortOrder,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                take: (
                    count: number,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

    sort: (
        key: string,
        sortOrder?: SortOrder,
    ) => Readonly<
        {
            compile: () => OrmSearch;
            pagination: (
                value: any,
            ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: ...; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
            take: (
                count: number,
            ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
        },
    > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

    Creates a sort.

    Type declaration

      • (
            key: string,
            sortOrder?: SortOrder,
        ): Readonly<
            {
                compile: () => OrmSearch;
                pagination: (
                    value: any,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: ...; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
                take: (
                    count: number,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

      • Parameters

        • key: string

          The key to sort on

        • OptionalsortOrder: SortOrder

          The order to sort by. Defaults to ascending.

        Returns Readonly<
            {
                compile: () => OrmSearch;
                pagination: (
                    value: any,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: ...; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; compile: () => OrmSearch; }> & Readonly<...>...;
                take: (
                    count: number,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

    take: (
        count: number,
    ) => Readonly<
        {
            compile: () => OrmSearch;
            pagination: (
                value: any,
            ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            sort: (
                key: string,
                sortOrder?: SortOrder,
            ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
            take: (count: number) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: ...; compile: () => OrmSearch; }> & Readonly<...>...;
        },
    > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

    Maximum number of elements to return.

    Type declaration

      • (
            count: number,
        ): Readonly<
            {
                compile: () => OrmSearch;
                pagination: (
                    value: any,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                sort: (
                    key: string,
                    sortOrder?: SortOrder,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                take: (count: number) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: ...; compile: () => OrmSearch; }> & Readonly<...>...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

      • Parameters

        • count: number

          The count

        Returns Readonly<
            {
                compile: () => OrmSearch;
                pagination: (
                    value: any,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                sort: (
                    key: string,
                    sortOrder?: SortOrder,
                ) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: (count: number) => Readonly<...> & ... 1 more ... & InnerBuilderV2; ...;
                take: (count: number) => Readonly<{ pagination: (value: any) => Readonly<...> & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder; }> & InnerBuilderV2; sort: (key: string, sortOrder?: SortOrder | undefined) => Readonly<...> & ... 1 more ... & InnerBuilderV2; take: ...; compile: () => OrmSearch; }> & Readonly<...>...;
            },
        > & Readonly<{ and: () => QueryBuilder; or: () => QueryBuilder }> & InnerBuilderV2

    Settings

    Member Visibility

    On This Page

    Properties