Skip to main content

talawa-api / Exports / utilities/graphQLConnection/getCommonGraphQLConnectionSort

Module: utilities/graphQLConnection/getCommonGraphQLConnectionSort

Table of contents​

Functions​

Functions​

getCommonGraphQLConnectionSort​

▸ getCommonGraphQLConnectionSort(«destructured»): CommmonGraphQLConnectionSort

This function is used to get an object containing common mongoose sorting logic.

Parameters​

NameType
«destructured»Object
› directionGraphQLConnectionTraversalDirection

Returns​

CommmonGraphQLConnectionSort

Remarks

Here are a few assumptions this function makes which are common to most of the graphQL connections.

The entity that has the latest creation datetime must appear at the top of the connection. This means the default sorting logic would be sorting in descending order by the time of creation of an entity, and if two or more entities have the same time of creation sorting in descending order by the primary key of the entity. MongoDB object ids are lexographically sortable all on their own because they contain information about both the creation time and primary key for the document.

Therefore, this function only returns sorting logic for sorting by the object id of a mongoDB document.

Example

const sort = getCommonGraphQLConnectionSort(\{
  direction: "BACKWARD"
 \});
const objectList = await User.find().sort(sort).limit(10);

Defined in​

src/utilities/graphQLConnection/getCommonGraphQLConnectionSort.ts:34