Interface: NearestQuery<Document>

server.NearestQuery Eligible documents ranked by distance, then document identity.

​

Type parameters

​

Methods

​

take

▸ take(count): Promise<NearestHit<Document>[]>

​

Parameters

​

Returns

Promise<NearestHit<Document>[]>

---

​

first

▸ first(): Promise<NearestHit<Document> | null>

​

Returns

Promise<NearestHit<Document> | null>

---

​

takeWithDiagnostics

▸ takeWithDiagnostics(count): Promise<ReadReport<NearestHit<Document>>>

​

Parameters

​

Returns

Promise<ReadReport<NearestHit<Document>>>

---

​

withBudget

▸ withBudget(budget): NearestQuery<Document>

​

Parameters

​

Returns

NearestQuery<Document>