Function queryReferenced

  • queryReferenced<CItem = Item>(
        collectionId: string,
        targetCollectionId: string,
        itemId: ItemID,
        propertyName: Extract<keyof CItem, string>,
        queryOptions: WeivDataQueryReferencedOptions,
        options?: WeivDataOptions,
    ): Promise<WeivDataQueryReferencedResult<CItem>>

  • Type Parameters

    Parameters

    • collectionId: string

      The ID of the collection that contains the referring items.

    • targetCollectionId: string

      The ID of the collection that contains the referenced items.

    • itemId: ItemID

      The referring item's ID.

    • propertyName: Extract<keyof CItem, string>

      The property that contains the references to the referenced items.

    • queryOptions: WeivDataQueryReferencedOptions

      An object containing options to use when querying referenced items.

    • Optionaloptions: WeivDataOptions

      An object containing options to use when processing this operation.

    Returns Promise<WeivDataQueryReferencedResult<CItem>>

    Fulfilled - The referenced items. Rejected - The error that caused the rejection.

    Description

    Gets the full items referenced in the specified property.

Settings

Member Visibility