@playstack/nest-search
Named NestJS search endpoints, transport-neutral execution, and optional dependency readiness checks.
Free. MIT licensed. Check preview availability before installing. See package access.
@playstack/nest-search registers named search sources and protocols while leaving route ownership, guards, authorization, and rate limits with the application.
PlaystackSearchModule.forRoot({
searches: {
docs: {
source: docsSearchSource,
protocol: docsSearchProtocol,
health: () => searchIndex.check(),
},
},
})An injected endpoint accepts Nest's parsed query and returns portable status, headers, and JSON. The application controller applies that result through Express or Fastify. No public route is registered implicitly.
Install
After confirming preview access, install the package at your application's shared Playstack version:
npm install --save-exact @playstack/nest-search@0.1.0-beta.1Check the peer requirements below before choosing a runtime or provider.
API entry points and requirements
Reference snapshot: @playstack/nest-search@0.1.0-beta.1. Import only the entry point your runtime needs. Paths below are relative to the installed package; use Go to Definition in your editor to inspect exact parameters, return types and overloads. Do not import the declaration-file paths directly.
| Public entry point | Declaration file |
|---|---|
@playstack/nest-search | ./dist/index.d.ts |
@playstack/nest-search/package.json | No TypeScript declaration (asset or metadata export). |
Node.js engine requirement: >=20. This is not a claim that every entry point works in browsers or Workers.
Peer dependencies
Keep existing framework versions that satisfy these ranges. Install optional peers only when using the corresponding adapter. The package manager resolves ordinary dependencies separately.
| Peer | Compatible range | When needed |
|---|---|---|
@nestjs/common | ^10.0.0 || ^11.0.0 | Required by the package. |
@playstack/search | 0.1.0-beta.1 | Required by the package. |
reflect-metadata | ^0.1.13 || ^0.2.0 | Required by the package. |
rxjs | ^7.0.0 | Required by the package. |
For a complete first program, start with Getting started. For API lookup and partial-example conventions, see Reading the reference. Provider failures, lifecycle requirements and application responsibilities remain described in the guide above; types alone do not establish production safety.