push.rocks/searchquery
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update tsconfig

Browse Source
This commit is contained in:
Philipp Kunz 2024-04-14 17:17:27 +02:00
parent ed5a4593f9
commit d95ca1c01f
4 changed files with 121 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
npmextra.json
View File

@ -5,17 +5,30 @@
"githost": "code.foss.global",
"gitscope": "push.rocks",
"gitrepo": "searchquery",
"description": "a module for dealing with searchqueries",
"description": "A module for parsing and handling search queries with debounce and customization options.",
"npmPackagename": "@push.rocks/searchquery",
"license": "MIT",
"projectDomain": "push.rocks"
"projectDomain": "push.rocks",
"keywords": [
"search query parsing",
"text search handling",
"debounce search input",
"search suggestions",
"custom search parser",
"observable search queries",
"TypeScript search module",
"reactive programming",
"npm package",
"module development",
"smart search processing"
]
}
},
"npmci": {
"npmGlobalTools": [],
"npmAccessLevel": "public"
},
"tsdocs": {
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
}
}

17
package.json
View File

@ -2,7 +2,7 @@
"name": "@push.rocks/searchquery",
"version": "1.0.3",
"private": false,
"description": "a module for dealing with searchqueries",
"description": "A module for parsing and handling search queries with debounce and customization options.",
"main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts",
"type": "module",
@ -37,5 +37,18 @@
"dependencies": {
"@pushrocks/smartrx": "^2.0.25",
"search-query-parser": "^1.6.0"
}
},
"keywords": [
"search query parsing",
"text search handling",
"debounce search input",
"search suggestions",
"custom search parser",
"observable search queries",
"TypeScript search module",
"reactive programming",
"npm package",
"module development",
"smart search processing"
]
}

1
readme.hints.md Normal file
View File

@ -0,0 +1 @@

116
readme.md
View File

@ -1,39 +1,101 @@
# @pushrocks/searchquery
# @push.rocks/searchquery
a module for dealing with searchqueries
## Availabililty and Links
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/searchquery)
* [gitlab.com (source)](https://gitlab.com/pushrocks/searchquery)
* [github.com (source mirror)](https://github.com/pushrocks/searchquery)
* [docs (typedoc)](https://pushrocks.gitlab.io/searchquery/)
## Install
## Status for master
To use `@push.rocks/searchquery` in your project, you need to install it via npm. You can do so by running the following command in your terminal:
Status Category | Status Badge
-- | --
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/searchquery/badges/master/pipeline.svg)](https://lossless.cloud)
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/searchquery/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/searchquery)](https://lossless.cloud)
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/searchquery)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/searchquery)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/searchquery)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/searchquery)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
```sh
npm install @push.rocks/searchquery --save
```
This will add `@push.rocks/searchquery` to your project's dependencies and allow you to start using it in your code.
## Usage
Use TypeScript for best in class intellisense
`@push.rocks/searchquery` is designed to enhance the handling of search queries within your application. It leverages the power of `search-query-parser` and `@pushrocks/smartrx` for parsing and reactive management of search queries. In this guide, we'll explore how to effectively use this module to its full potential.
## Contribution
### Initializing SearchQuery
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
First, let's start by importing and initializing the `SearchQuery` class from `@push.rocks/searchquery`. You will need to provide it with appropriate options.
For further information read the linked docs at the top of this readme.
```typescript
import { SearchQuery } from '@push.rocks/searchquery';
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
const searchQueryOptions = {
debounceMs: 300, // Milliseconds to debounce the search input
searchParserOptions: { // Options passed to 'search-query-parser'
keywords: ['tag', 'author'],
ranges: ['date'],
tokenize: true,
alwaysArray: true,
},
};
const mySearchQuery = new SearchQuery(searchQueryOptions);
```
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)
The `debounceMs` option allows you to set a debounce time for processing the search query, which can help in reducing the frequency of search operation execution, making it more efficient especially for applications that perform real-time search query processing.
The `searchParserOptions` are directly passed to the `search-query-parser`. In this example, we specify that we want to parse for keywords such as `tag` and `author`, and for range queries like `date`. We also configure the parser to always return the results as an array and to tokenize the input.
### Feeding the Search String
To process a search string, you'll need to feed it into your `SearchQuery` instance. Typically, you'd do this in response to a user action, such as typing in a search input on a UI. Below is an example of how you might do this:
```typescript
// Placeholder function to simulate user input
async function simulateUserInput(input: string) {
// Here you would feed the user input to the search query
// In a real application, this might be triggered by an event listener on a search input field
}
// Example usage
simulateUserInput('tag:important author:John');
```
### Subscribing to Search Query Changes
`SearchQuery` utilizes reactive programming principles by using a Subject from the `@pushrocks/smartrx` package. You can subscribe to the search query's changes and get notified whenever the search query is updated. This is particularly useful for implementing real-time search features where the search results are dynamically updated as the user types.
```typescript
mySearchQuery.querySubject.subscribe({
next: (searchQueryResult) => {
console.log('New search query result:', searchQueryResult);
// Here you would typically update the search results in your UI based on the new searchQueryResult
},
error: (err) => {
console.error('Something went wrong with the search query subscription:', err);
},
});
```
This setup allows you to build highly interactive and responsive search experiences in your web application while keeping the complexity of handling search queries and results manageable.
### Advanced Usage
`@push.rocks/searchquery` is designed to be flexible and extensible. You can further customize its behavior by exploring additional options available in the `search-query-parser` library and integrating more features from the `@pushrocks/smartrx` package for advanced reactive programming patterns.
Remember to explore the APIs and documentation of these underlying libraries to fully leverage the power of `@push.rocks/searchquery` in your projects.
## Conclusion
`@push.rocks/searchquery` offers a powerful and flexible way to handle search queries in your application. By combining the capabilities of `search-query-parser` for parsing complex queries and `@pushrocks/smartrx` for reactive programming, it provides a robust solution for managing and responding to user-generated search queries in real time. Whether you are building a search-intensive application or just need a sophisticated mechanism to deal with search queries, `@push.rocks/searchquery` is a valuable tool to have in your development toolkit.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.