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

fix(readme): Update readme to clarify usage of searchable fields retrieval

Browse Source
This commit is contained in:
Philipp Kunz 2025-04-21 17:31:30 +00:00
parent ac80f90ae0
commit 969b073939
3 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
changelog.md
View File

@ -1,5 +1,11 @@
# Changelog # Changelog
## 2025-04-21 - 5.11.2 - fix(readme)
Update readme to clarify usage of searchable fields retrieval
- Replaced getSearchableFields('Product') with Product.getSearchableFields()
- Updated documentation to reference the static method Class.getSearchableFields()
## 2025-04-21 - 5.11.1 - fix(doc) ## 2025-04-21 - 5.11.1 - fix(doc)
Refactor searchable fields API and improve collection registration. Refactor searchable fields API and improve collection registration.

4
readme.md
View File

@ -203,7 +203,7 @@ class Product extends SmartDataDbDoc<Product, Product> {
} }
// List searchable fields // List searchable fields
const searchableFields = getSearchableFields('Product'); const searchableFields = Product.getSearchableFields();
// 1: Exact phrase across all fields // 1: Exact phrase across all fields
await Product.search('"Kindle Paperwhite"'); await Product.search('"Kindle Paperwhite"');
@ -230,7 +230,7 @@ await Product.search('');
The search functionality includes: The search functionality includes:
- `@searchable()` decorator for marking fields as searchable - `@searchable()` decorator for marking fields as searchable
- `getSearchableFields()` to list searchable fields for a model - `Class.getSearchableFields()` static method to list searchable fields for a model
- `search(query: string)` method supporting: - `search(query: string)` method supporting:
- Exact phrase matches (`"my exact string"` or `'my exact string'`) - Exact phrase matches (`"my exact string"` or `'my exact string'`)
- Field‑scoped exact & wildcard searches (`field:value`, `field:Air*`) - Field‑scoped exact & wildcard searches (`field:value`, `field:Air*`)

2
ts/00_commitinfo_data.ts
View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@push.rocks/smartdata', name: '@push.rocks/smartdata',
version: '5.11.1', version: '5.11.2',
description: 'An advanced library for NoSQL data organization and manipulation using TypeScript with support for MongoDB, data validation, collections, and custom data types.' description: 'An advanced library for NoSQL data organization and manipulation using TypeScript with support for MongoDB, data validation, collections, and custom data types.'
} }