Type alias RefPropertyDefault

RefPropertyDefault: {
    includeVector?: boolean | string[];
    linkOn: string;
    returnMetadata?: QueryMetadata;
    returnProperties?: (string | QueryNestedDefault)[];
    returnReferences?: RefPropertyDefault[];
    targetCollection?: string;
}

Type declaration

  • Optional includeVector?: boolean | string[]

    Whether to return the vector(s) of the referenced objects in the query.

  • linkOn: string

    The property to link on when defining the references traversal.

  • Optional returnMetadata?: QueryMetadata

    The metadata to return for the referenced objects.

  • Optional returnProperties?: (string | QueryNestedDefault)[]

    The properties to return for the referenced objects.

  • Optional returnReferences?: RefPropertyDefault[]

    The references to return for the referenced objects.

  • Optional targetCollection?: string

    The collection to target when traversing the references. Required for multi-target references.

Settings

Member Visibility

Theme