docs(examples): add metadata filter operator snippets - #438
Conversation
There was a problem hiding this comment.
All reported issues were addressed across 7 files
Reply with feedback, questions, or to request a fix.
Fix all with cubic | Re-trigger cubic
|
Update: I was able to complete the CLA from another device. The CLA check now shows signed. Thanks. |
There was a problem hiding this comment.
Pull request overview
Adds runnable, copy-pasteable TypeScript examples demonstrating metadata filter operators in the JavaScript examples package (examples/javascript/), aligning with the repo’s goal of providing practical SDK usage snippets.
Changes:
- Added four runnable operator-focused scripts for
$eq,$and,$in, and$nearunderexamples/javascript/metadata-filters/. - Introduced a shared helper to centralize setup (env, temporary index creation/loading), querying, and teardown.
- Updated the JavaScript examples README and
package.jsonscripts to make running the new samples straightforward.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| examples/javascript/README.md | Documents the new metadata filter operator samples and how to run them. |
| examples/javascript/package.json | Adds npm run metadata:* scripts to run each operator snippet. |
| examples/javascript/metadata-filters/shared.ts | Shared runner that creates a temporary index, performs a filtered query, prints results, and cleans up. |
| examples/javascript/metadata-filters/eq.ts | Runnable $eq filter example. |
| examples/javascript/metadata-filters/and.ts | Runnable $and composition example. |
| examples/javascript/metadata-filters/in.ts | Runnable $in filter example. |
| examples/javascript/metadata-filters/near.ts | Runnable $near geo-distance filter example. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codex reviewThe examples are structured clearly, but the shared helper currently widens metadata filters enough to break TypeScript checking against the SDK query type. |
Summary
$eq,$and,$in, and$nearunderexamples/javascript/metadata-filters/.Closes #417
Verification
npm cinpm run type-checknpm run lintgit diff --checkNotes
The examples require real
MOSS_PROJECT_IDandMOSS_PROJECT_KEYcredentials to run end-to-end. I verified them with the local TypeScript and ESLint checks; at runtime they create a temporary index, run one filtered query, and delete the index.