npmpackage.info

Gathering detailed insights and metrics for nestjs-dataloader

nestjs-dataloader

Dataloader plugin for NestJS

9.0.0

148

MIT

TypeScript

1.00 kB

482,390 3

Installations

npm install nestjs-dataloader

Pull Requests

Open

6

Total

35

Closed

14

Merged

15

Issues

Open

17

Total

29

Closed

12

Releases

General Bug Fixes

7.0.1

Published on 13 May 2020

NestJS 7 compatibility

7.0.0

Published on 07 Apr 2020

2.0.4

Published on 21 Mar 2020

View all 3 releases

Developer

krislefeber

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

14.18.1

NPM Version

6.14.15 Statistics

148 Stars

88 Commits

45 Forks

7 Watching

3 Branches

11 Contributors

Updated on 23 May 2024

Bundle Size

2.09 kB

Minified

1.00 kB

Minified + Gzipped

Bundlephobia

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

482,390

Last day

-29.4%

353

Compared to previous day

Last week

-15.3%

2,059

Compared to previous week

Last month

15.2%

9,908

Compared to previous month

Last year

-4%

120,641

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

NestJS Dataloader

NestJS dataloader simplifies adding graphql/dataloader to your NestJS project. DataLoader aims to solve the common N+1 loading problem.

Installation

Install with yarn

1yarn add nestjs-dataloader

Install with npm

1npm install --save nestjs-dataloader

Usage

NestDataLoader Creation

We start by implementing the NestDataLoader interface. This tells DataLoader how to load our objects.

1import * as DataLoader from 'dataloader';
2import { Injectable } from '@nestjs/common';
3import { NestDataLoader } from 'nestjs-dataloader';
4...
5
6@Injectable()
7export class AccountLoader implements NestDataLoader<string, Account> {
8  constructor(private readonly accountService: AccountService) { }
9
10  generateDataLoader(): DataLoader<string, Account> {
11    return new DataLoader<string, Account>(keys => this.accountService.findByIds(keys));
12  }
13}

The first generic of the interface is the type of ID the datastore uses. The second generic is the type of object that will be returned. In the above instance, we want DataLoader to return instances of the Account class.

Providing the NestDataLoader

For each NestDataLoader we create, we need to provide it to our module.

1import { Module } from '@nestjs/common';
2import { APP_INTERCEPTOR } from '@nestjs/core';
3import {DataLoaderInterceptor} from 'nestjs-dataloader'
4...
5
6@Module({
7  providers: [
8    AccountResolver,
9    AccountLoader,
10    {
11      provide: APP_INTERCEPTOR,
12      useClass: DataLoaderInterceptor,
13    },
14  ],
15
16})
17export class ResolversModule { }

Using the NestDataLoader

Now that we have a dataloader and our module is aware of it, we need to pass it as a parameter to an endpoint in our graphQL resolver.

1import * as DataLoader from 'dataloader';
2import { Loader } from 'nestjs-dataloader';
3...
4
5@Resolver(Account)
6export class AccountResolver {
7
8    @Query(() => [Account])
9    public getAccounts(
10        @Args({ name: 'ids', type: () => [String] }) ids: string[],
11        @Loader(AccountLoader) accountLoader: DataLoader<Account['id'], Account>): Promise<Account[]> {
12        return accountLoader.loadMany(ids);
13    }
14}

The important thing to note is that the parameter of the @Loader decorator is the entity/class of the NestDataLoader we want to be injected to the method. The DataLoader library will handle bulk retrieval and caching of our requests. Note that the caching is stored on a per-request basis.

Contributing

Pull requests are always welcome. For major changes, please open an issue first to discuss what you would like to change.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

5

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

nestjs-dataloader

Installations

Pull Requests

6

35

14

15

Issues

17

29

12

Releases

Developer

Developer Guide

CommonJS

Yes

14.18.1

6.14.15

Statistics

Bundle Size

2.09 kB

1.00 kB

Languages

Total Downloads

482,390

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

NestJS Dataloader

Installation

Usage

NestDataLoader Creation

Providing the NestDataLoader

Using the NestDataLoader

Contributing

10

10

10

5

0

0

0

0

0

0

0

0

0

3

/10