npmpackage.info

Gathering detailed insights and metrics for @redis/search

Gathering detailed insights and metrics for @redis/search

@redis/search - 5.6.0 | npmpackage.info

@redis/search

Redis Node.js client

5.6.0

17,245

MIT

TypeScript

221.24 kB

Installations

npm install @redis/search

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Min. Node Version

>= 18

Node Version

22.16.0

NPM Version

10.9.2

Pull Requests

Open

62

Total

1,051

Closed

387

Merged

602

Issues

Open

307

Total

1,909

Closed

1,602

Releases

144

redis@5.6.0

Updated on Jul 08, 2025

redis@5.5.6

Updated on Jun 06, 2025

redis@5.1.1

Updated on May 28, 2025

redis@5.1.0

Updated on May 20, 2025

redis@5.0.1

Updated on May 05, 2025

redis@5.0.0

Updated on Apr 30, 2025

View All 144 releases

Languages

4

TypeScript

JavaScript

Dockerfile

Shell

TypeScript (99.43%)

JavaScript (0.56%)

Dockerfile (0.01%)

Developer

Download Statistics

Total Downloads

0

Last Day

0

Last Week

0

Last Month

0

Last Year

0

GitHub Statistics

MIT License

17,245 Stars

2,167 Commits

1,908 Forks

294 Watchers

24 Branches

281 Contributors

Updated on Jul 17, 2025

Maintainers

3

View All 281 Contributors

Package Meta Information

Latest Version

5.6.0

Package Id

@redis/search@5.6.0

Unpacked Size

221.24 kB

Size

35.89 kB

File Count

150

NPM Version

10.9.2

Node Version

22.16.0

Published on

Jul 08, 2025

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

0%

NaN

Compared to previous day

Last Week

0%

NaN

Compared to previous week

Last Month

0%

NaN

Compared to previous month

Last Year

0%

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

1

Dev Dependencies

1

@redis/test-utils

@redis/search

This package provides support for the RediSearch module, which adds indexing and querying support for data stored in Redis Hashes or as JSON documents with the RedisJSON module.

Should be used with redis/@redis/client.

:warning: To use these extra commands, your Redis server must have the RediSearch module installed. To index and query JSON documents, you'll also need to add the RedisJSON module.

Usage

For complete examples, see search-hashes.js and search-json.js in the examples folder.

Indexing and Querying Data in Redis Hashes

Creating an Index

Before we can perform any searches, we need to tell RediSearch how to index our data, and which Redis keys to find that data in. The FT.CREATE command creates a RediSearch index. Here's how to use it to create an index we'll call idx:animals where we want to index hashes containing name, species and age fields, and whose key names in Redis begin with the prefix noderedis:animals:

1await client.ft.create('idx:animals', {
2  name: {
3    type: SCHEMA_FIELD_TYPE.TEXT,
4    SORTABLE: true
5  },
6  species: SCHEMA_FIELD_TYPE.TAG,
7  age: SCHEMA_FIELD_TYPE.NUMERIC
8}, {
9  ON: 'HASH',
10  PREFIX: 'noderedis:animals'
11});

See the FT.CREATE documentation for information about the different field types and additional options.

Querying the Index

Once we've created an index, and added some data to Redis hashes whose keys begin with the prefix noderedis:animals, we can start writing some search queries. RediSearch supports a rich query syntax for full-text search, faceted search, aggregation and more. Check out the FT.SEARCH documentation and the query syntax reference for more information.

Let's write a query to find all the animals where the species field has the value dog:

1const results = await client.ft.search('idx:animals', '@species:{dog}');

results looks like this:

1{
2  total: 2,
3  documents: [
4    {
5      id: 'noderedis:animals:4',
6      value: {
7        name: 'Fido',
8        species: 'dog',
9        age: '7'
10      }
11    },
12    {
13      id: 'noderedis:animals:3',
14      value: {
15        name: 'Rover',
16        species: 'dog',
17        age: '9'
18      }
19    }
20  ]
21}

Indexing and Querying Data with RedisJSON

RediSearch can also index and query JSON documents stored in Redis using the RedisJSON module. The approach is similar to that for indexing and searching data in hashes, but we can now use JSON Path like syntax and the data no longer has to be flat name/value pairs - it can contain nested objects and arrays.

Creating an Index

As before, we create an index with the FT.CREATE command, this time specifying we want to index JSON documents that look like this:

1{
2  name: 'Alice',
3  age: 32,
4  coins: 100
5}

Each document represents a user in some system, and users have name, age and coins properties.

One way we might choose to index these documents is as follows:

1await client.ft.create('idx:users', {
2  '$.name': {
3    type: SCHEMA_FIELD_TYPE.TEXT,
4    SORTABLE: 'UNF'
5  },
6  '$.age': {
7    type: SCHEMA_FIELD_TYPE.NUMERIC,
8    AS: 'age'
9  },
10  '$.coins': {
11    type: SCHEMA_FIELD_TYPE.NUMERIC,
12    AS: 'coins'
13  }
14}, {
15  ON: 'JSON',
16  PREFIX: 'noderedis:users'
17});

Note that we're using JSON Path to specify where the fields to index are in our JSON documents, and the AS clause to define a name/alias for each field. We'll use these when writing queries.

Querying the Index

Now we have an index and some data stored as JSON documents in Redis (see the JSON package documentation for examples of how to store JSON), we can write some queries...

We'll use the RediSearch query language and FT.SEARCH command. Here's a query to find users under the age of 30:

1await client.ft.search('idx:users', '@age:[0 30]');

Empty State

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

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

10

Security-Policy

Determines if the project has published a security policy.

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.

10

SAST

Determines if the project uses static code analysis.

6

Branch-Protection

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

3

Code-Review

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

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 2

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:41: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:59: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql.yml:72: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/codeql.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/documentation.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/documentation.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/documentation.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter-bloom.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release-drafter-bloom.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter-entraid.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release-drafter-entraid.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter-json.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release-drafter-json.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter-search.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release-drafter-search.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-drafter-time-series.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release-drafter-time-series.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:29: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/stale-issues.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/stale-issues.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/tests.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/tests.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/redis/node-redis/tests.yml/master?enable=pin
Warn: containerImage not pinned by hash: packages/test-utils/docker/Dockerfile:2
Warn: npmCommand not pinned by hash: .github/workflows/tests.yml:36
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 5 third-party GitHubAction dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned
Info: 3 out of 4 npmCommand dependencies pinned

0

CII-Best-Practices

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

0

Token-Permissions

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

0

Fuzzing

Determines if the project uses fuzzing.

Score

5.9

/10

Last Scanned on 2025-07-07

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.