Gathering detailed insights and metrics for rxdb-search
Gathering detailed insights and metrics for rxdb-search
Installations
npm install rxdb-searchDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
12.20.0
NPM Version
6.14.8
Releases
Unable to fetch releases
Languages
2
TypeScript
JavaScript
TypeScript (99.65%)
JavaScript (0.35%)
Developer
doriandrn
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
16 Stars
27 Commits
1 Forks
2 Watchers
2 Branches
1 Contributors
Updated on Apr 02, 2025
Maintainers
1
Package Meta Information
Latest Version
1.1.1
Package Id
rxdb-search@1.1.1
Unpacked Size
8.02 kB
Size
3.49 kB
File Count
4
NPM Version
6.14.8
Node Version
12.20.0
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
Dependencies
2
Dev Dependencies
23
@babel/core@babel/preset-env@babel/preset-typescript@rollup/plugin-babel@rollup/plugin-commonjs@rollup/plugin-typescript@types/jest@types/nodeaxiosbroadcast-channelencoding-downjestpouchdb-adapter-memoryrolluprollup-plugin-browserify-transformrollup-plugin-node-builtinsrollup-plugin-node-globalsrollup-plugin-node-resolverollup-plugin-terserrollup-plugin-typescriptrxjsts-jesttypescript
RxDB Search plugin
Minimal full text search implementation plugin for RxDB based on search-index.
Disclaimer for v1.1.0+ using search-index v2.1.0
The on remove test still fails, meaning the si.DELETE function is mishaving - I'm clueless on how to fix it right now so please expect this to work in a further version!
Install
1npm i rxdb-search search-index --save
API
Default usage:
1import { addRxPlugin } from 'rxdb' 2import rxdbSearch from 'rxdb-search' 3 4addRxPlugin(rxdbSearch) 5 6... 7 8 9const { RESULT, RESULT_LENGTH } = await collection.search(query: string, siQUERYoptions ?: {}) 10console.log(RESULT) 11 12/* 13`collection.search` is just a shortcut / an alias to si.QUERY using just the AND operator, that accepts a string as the `query` parameter. 14 15`collection.si` can also be accessed for the complete [search-index API](https://github.com/fergiemcdowall/search-index/tree/master/docs) on the collection. 16*/ 17 18const { QUERY } = collection.si
Please consult the search-index API for the full operatoins you can do on the collection.
For existing datasets, you can index them by using:
1await collection.index()
This is a costly operation and it should be done only once. Indexes add themselves up afterwards when new documents are added.
Or index just some of them by providing an ids array argument:
1const ids = ['id1', 'id2'] 2await collection.index(ids)
If you're using .bulkInsert(), you may need to "manually" index the inserted documents (the .postInsert hook is not triggered as of now):
1const { success, error } = await collection.bulkInsert(data) 2 3// Get ids, 'success' is an array of maps. 4const ids = success.map((undefined, i) => success[i].get('_id')) 5await collection.index(ids)
More to come soon! Stay tuned!
Suggestions, feedback or PRs are welcome!
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 0/27 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/main.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/doriandrn/rxdb-search/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/doriandrn/rxdb-search/main.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/main.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/doriandrn/rxdb-search/main.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/main.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/doriandrn/rxdb-search/main.yml/main?enable=pin
- Warn: npmCommand not pinned by hash: .github/workflows/main.yml:35
- Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 1 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 npmCommand dependencies pinned
Reason
no SAST tool detected
Details
- Warn: no pull requests merged into dev branch
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'main'
Score
3.4
/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.
Learn More