Installations

npm install nestjs-algoliasearch

Pull Requests

Open

11

Total

207

Closed

191

Merged

5

Issues

Open

0

Total

1

Closed

1

Releases

5

Release 1.0.0

1.0.0

Published on 01 Jul 2021

Release 0.1.3

0.1.3

Published on 07 Jul 2020

Release 0.1.2

0.1.2

Published on 08 May 2020

Release 0.1.1

0.1.1

Published on 08 May 2020

Release 0.1.0

0.1.0

Published on 08 May 2020

View all 5 releases

Developer

Davide-Gheri

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

14.15.0

NPM Version

7.5.4 Statistics

6 Stars

24 Commits

3 Forks

1 Watching

12 Branches

2 Contributors

Updated on 18 Mar 2024

Languages

TypeScript (73.59%)

JavaScript (24.65%)

Shell (1.76%)

Total Downloads

Cumulative downloads

Total Downloads

25,017

Last day

183.3%

34

Compared to previous day

Last week

56.7%

163

Compared to previous week

Last month

-16.2%

600

Compared to previous month

Last year

-11%

4,764

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

3

@nestjs/common @nestjs/core algoliasearch

Dev Dependencies

26

Versions

nestjs-algoliasearch

Algolia search module for NestJS, using the official algoliasearch package

Install

1npm install nestjs-algoliasearch algoliasearch

or

1yarn add nestjs-algoliasearch algoliasearch

Getting started

Register the module

1// app.module.ts
2import { AlgoliaModule } from 'nestjs-algoliasearch';
3
4@Module({
5  imports: [
6    //...
7    AlgoliaModule.forRoot({
8      applicationId: 'ALGOLIA_APPLICATION_ID',
9      apiKey: 'ALGOLIA_API_KEY',
10    }),
11
12    // Or async:
13    AlgoliaModule.forRootAsync({
14      imports: [ConfigModule],
15      inject: [ConfigService],
16      useFactory: (config: ConfigService) => config.get('algolia'),
17    }),
18    //...
19  ],
20})
21export class AppModule {}

Register the indexes

1// todo.module.ts
2import { AlgoliaModule } from 'nestjs-algoliasearch';
3
4@Module({
5  imports: [
6    TypeOrmModule.forFeature([
7      TodoEntity,
8    ]),
9    AlgoliaModule.forFeature([{
10      name: TodoEntity, // Or a string, this will be the index name
11      options: {/* custom Algolia client index settings */},
12    }])
13  ],
14})
15export class TodoModule {}

See the official Algolia client documentatin for a list of all available Index options

Using the registered Index

The Index is injectable using the @InjectIndex decorator, the returned value is an algoliasearch.SearchIndex.

See the official Algolia client documentation for a list of available methods

1// todo.service.ts
2import { InjectIndex } from 'nestjs-algoliasearch';
3import { SearchIndex } from 'algoliasearch';
4
5@Injectable()
6export class TodoService {
7  constructor(
8    @InjectIndex(TodoEntity /* or the string used as "name" prop while registering the index */)
9    private readonly todoIndex: SearchIndex,
10  )
11}

No vulnerabilities found.

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

0

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

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.

Reason

39 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-4jpv-8r57-pv7j
Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6
Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-px4h-xg32-q955
Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6
Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj
Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp

Score

1.7

/10

Last Scanned on 2024-11-25

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