Interface Query<T>

interface Query<T> {
    "~Query": { value: T };
    ast:
        | QuerySelectClause
        | QueryFilterClause
        | QueryReferenceTraversalClause
        | QueryIncomingReferencesClause
        | QueryRelationClause
        | QueryRelationTraversalClause
        | QueryUnionClause
        | QuerySetDifferenceClause
        | QueryOrderClause
        | QueryOptionsClause;
    options(options: QueryOptions): Query<T>;
    orderBy(...order: [Order<T>, ...Order<T>[]]): Query<T>;
    reference<K extends string>(
        key: K,
    ): Query<
        T[K] extends Any
            ? Target<any[any]>
            : T[K] extends undefined
            | Any
                ? Target<Exclude<any[any], undefined>>
                : never,
    >;
    referencedBy<S extends All>(
        target: string | S,
        key: RefPropKey<Type<S>>,
    ): Query<Type<S>>;
    select(filter: Filter<T>): Query<T>;
    select(props: Props<T>): Query<T>;
    source(): Query<Type.Relation.Source<T>>;
    sourceOf<S extends All>(
        relation: string | S,
        predicates?: Props<Type<S>>,
    ): Query<Type<S>>;
    target(): Query<Type.Relation.Target<T>>;
    targetOf<S extends All>(
        relation: string | S,
        predicates?: Props<Type<S>>,
    ): Query<Type<S>>;
}

Type Parameters

Index

Properties

~Query ast

Methods

options orderBy reference referencedBy select source sourceOf target targetOf

Properties

~Query

"~Query": { value: T }

ast

Methods

options

options(options: QueryOptions): Query<T>
Add options to a query.
Parameters
- options: QueryOptions
Returns Query<T>
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:71

orderBy

orderBy(...order: [Order<T>, ...Order<T>[]]): Query<T>
Order the query results. Orders are specified in priority order. The first order will be applied first, etc.
Parameters
- ...order: [Order<T>, ...Order<T>[]]
  Order to sort the results.
Returns Query<T>
Query for the ordered results.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:67

reference

reference<K extends string>(
    key: K,
): Query<
    T[K] extends Any
        ? Target<any[any]>
        : T[K] extends undefined
        | Any
            ? Target<Exclude<any[any], undefined>>
            : never,
>
Traverse an outgoing reference.
Type Parameters
- K extends string
Parameters
- key: K
  Property path inside T that is a reference or optional reference.
Returns Query<
    T[K] extends Any
        ? Target<any[any]>
        : T[K] extends undefined
        | Any
            ? Target<Exclude<any[any], undefined>>
            : never,
>
Query for the target of the reference.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:29

referencedBy

referencedBy<S extends All>(
target: string | S,
key: RefPropKey<Type<S>>,
): Query<Type<S>>
Find objects referencing this object.
Type Parameters
- S extends All
Parameters
- target: string | S
  Schema of the referencing object.
- key: RefPropKey<Type<S>>
  Property path inside the referencing object that is a reference.
Returns Query<Type<S>>
Query for the referencing objects.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:36

select

select(filter: Filter<T>): Query<T>
Filter the current selection based on a filter.
Parameters
- filter: Filter<T>
  Filter to select the objects.
Returns Query<T>
Query for the selected objects.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:22
select(props: Props<T>): Query<T>
Parameters
- props: Props<T>
Returns Query<T>
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:23

source

source(): Query<Type.Relation.Source<T>>
For a query for relations, get the source objects.

Returns Query<Type.Relation.Source<T>>
Query for the source objects.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:55

sourceOf

sourceOf<S extends All>(
relation: string | S,
predicates?: Props<Type<S>>,
): Query<Type<S>>
Find relations where this object is the source.
Type Parameters
- S extends All
Parameters
- relation: string | S
  Schema of the relation.
- Optionalpredicates: Props<Type<S>>
  Predicates to filter the relation objects.
Returns Query<Type<S>>
Query for the relation objects.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:43

target

target(): Query<Type.Relation.Target<T>>
For a query for relations, get the target objects.

Returns Query<Type.Relation.Target<T>>
Query for the target objects.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:60

targetOf

targetOf<S extends All>(
relation: string | S,
predicates?: Props<Type<S>>,
): Query<Type<S>>
Find relations where this object is the target.
Type Parameters
- S extends All
Parameters
- relation: string | S
  Schema of the relation.
- Optionalpredicates: Props<Type<S>>
  Predicates to filter the relation objects.
Returns Query<Type<S>>
Query for the relation objects.
- Defined in packages/core/echo/echo/dist/types/src/query/query.d.ts:50

Interface Query<T>

Type Parameters

Index

Properties

Methods

Properties

~Query

ast

Methods

options

Parameters

Returns Query<T>

orderBy

Parameters

Returns Query<T>

reference

Type Parameters

Parameters

Returns Query< T[K] extends Any ? Target<any[any]> : T[K] extends undefined | Any ? Target<Exclude<any[any], undefined>> : never,>

referencedBy

Type Parameters

Parameters

Returns Query<Type<S>>

select

Parameters

Returns Query<T>

Parameters

Returns Query<T>

source

Returns Query<Type.Relation.Source<T>>

sourceOf

Type Parameters

Parameters

Returns Query<Type<S>>

target

Returns Query<Type.Relation.Target<T>>

targetOf

Type Parameters

Parameters

Returns Query<Type<S>>

Settings

On This Page

Returns Query<
T[K] extends Any
? Target<any[any]>
: T[K] extends undefined
| Any
? Target<Exclude<any[any], undefined>>
: never,
>