Skip to main content

Getting Started

Nestjs-Query is collection of packages to make crud for graphql (and potentially other transports) easier.

Why?#

While working on projects in nestjs it was very easy to get up and running with typeorm and graphql however, there were many patterns that were common between the resolvers. In particular querying, sorting and paging.

Features#

Install#

Check out the installation docs

Packages#

Nestjs-query is composed of multiple packages

  • @nestjs-query/core - Defines all interfaces and utility types implemented by the other packages.
  • @nestjs-query/query-graphql - Package that provides the graphql resolver and decorators for crud endpoints.
  • @nestjs-query/query-typeorm - Package that implements a Typeorm service that can be used by itself or with the graphql resolver provided by @nestjs-query/query-graphql.
  • @nestjs-query/query-sequelize - Package that implements a Sequelize service that can be used by itself or with the graphql resolver provided by @nestjs-query/query-graphql.
  • @nestjs-query/query-mongoose - Package that implements a Mongoose service that can be used by itself or with the graphql resolver provided by @nestjs-query/query-graphql.
  • @nestjs-query/query-typegoose - Package that implements a Typegoose service that can be used by itself or with the graphql resolver provided by @nestjs-query/query-graphql.

Migration Guides#