docs: better formatting for Node API docs (#1892)

* Sets `"useCodeBlocks": true`
* Adds a post-processing script `nodejs/typedoc_post_process.js` that
puts the parameter description on the same line as the parameter name,
like it is in our Python docs. This makes the text hierarchy clearer in
those sections and also makes the sections shorter.
This commit is contained in:
Will Jones
2024-12-09 17:04:09 -08:00
committed by GitHub
parent a43193c99b
commit db125013fc
45 changed files with 1538 additions and 488 deletions

View File

@@ -16,11 +16,13 @@ A builder for LanceDB queries.
### new Query()
> **new Query**(`tbl`): [`Query`](Query.md)
```ts
new Query(tbl): Query
```
#### Parameters
**tbl**: `Table`
* **tbl**: `Table`
#### Returns
@@ -34,7 +36,9 @@ A builder for LanceDB queries.
### inner
> `protected` **inner**: `Query` \| `Promise`<`Query`>
```ts
protected inner: Query | Promise<Query>;
```
#### Inherited from
@@ -44,7 +48,9 @@ A builder for LanceDB queries.
### \[asyncIterator\]()
> **\[asyncIterator\]**(): `AsyncIterator`&lt;`RecordBatch`&lt;`any`&gt;, `any`, `undefined`&gt;
```ts
asyncIterator: AsyncIterator<RecordBatch<any>, any, undefined>
```
#### Returns
@@ -58,11 +64,13 @@ A builder for LanceDB queries.
### doCall()
> `protected` **doCall**(`fn`): `void`
```ts
protected doCall(fn): void
```
#### Parameters
**fn**
* **fn**
#### Returns
@@ -76,13 +84,15 @@ A builder for LanceDB queries.
### execute()
> `protected` **execute**(`options`?): [`RecordBatchIterator`](RecordBatchIterator.md)
```ts
protected execute(options?): RecordBatchIterator
```
Execute the query and return the results as an
#### Parameters
**options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
#### Returns
@@ -108,15 +118,16 @@ single query)
### explainPlan()
> **explainPlan**(`verbose`): `Promise`&lt;`string`&gt;
```ts
explainPlan(verbose): Promise<string>
```
Generates an explanation of the query execution plan.
#### Parameters
**verbose**: `boolean` = `false`
If true, provides a more detailed explanation. Defaults to false.
* **verbose**: `boolean` = `false`
If true, provides a more detailed explanation. Defaults to false.
#### Returns
@@ -141,15 +152,38 @@ const plan = await table.query().nearestTo([0.5, 0.2]).explainPlan();
***
### fastSearch()
```ts
fastSearch(): this
```
Skip searching un-indexed data. This can make search faster, but will miss
any data that is not yet indexed.
Use lancedb.Table#optimize to index all un-indexed data.
#### Returns
`this`
#### Inherited from
[`QueryBase`](QueryBase.md).[`fastSearch`](QueryBase.md#fastsearch)
***
### ~~filter()~~
> **filter**(`predicate`): `this`
```ts
filter(predicate): this
```
A filter statement to be applied to this query.
#### Parameters
**predicate**: `string`
* **predicate**: `string`
#### Returns
@@ -169,9 +203,33 @@ Use `where` instead
***
### fullTextSearch()
```ts
fullTextSearch(query, options?): this
```
#### Parameters
* **query**: `string`
* **options?**: `Partial`&lt;`FullTextSearchOptions`&gt;
#### Returns
`this`
#### Inherited from
[`QueryBase`](QueryBase.md).[`fullTextSearch`](QueryBase.md#fulltextsearch)
***
### limit()
> **limit**(`limit`): `this`
```ts
limit(limit): this
```
Set the maximum number of results to return.
@@ -180,7 +238,7 @@ called then every valid row from the table will be returned.
#### Parameters
**limit**: `number`
* **limit**: `number`
#### Returns
@@ -194,11 +252,13 @@ called then every valid row from the table will be returned.
### nativeExecute()
> `protected` **nativeExecute**(`options`?): `Promise`&lt;`RecordBatchIterator`&gt;
```ts
protected nativeExecute(options?): Promise<RecordBatchIterator>
```
#### Parameters
**options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
#### Returns
@@ -212,7 +272,9 @@ called then every valid row from the table will be returned.
### nearestTo()
> **nearestTo**(`vector`): [`VectorQuery`](VectorQuery.md)
```ts
nearestTo(vector): VectorQuery
```
Find the nearest vectors to the given query vector.
@@ -232,7 +294,7 @@ If there is more than one vector column you must use
#### Parameters
**vector**: `IntoVector`
* **vector**: `IntoVector`
#### Returns
@@ -264,9 +326,49 @@ a default `limit` of 10 will be used.
***
### nearestToText()
```ts
nearestToText(query, columns?): Query
```
#### Parameters
* **query**: `string`
* **columns?**: `string`[]
#### Returns
[`Query`](Query.md)
***
### offset()
```ts
offset(offset): this
```
#### Parameters
* **offset**: `number`
#### Returns
`this`
#### Inherited from
[`QueryBase`](QueryBase.md).[`offset`](QueryBase.md#offset)
***
### select()
> **select**(`columns`): `this`
```ts
select(columns): this
```
Return only the specified columns.
@@ -290,7 +392,7 @@ input to this method would be:
#### Parameters
**columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
* **columns**: `string` \| `string`[] \| `Record`&lt;`string`, `string`&gt; \| `Map`&lt;`string`, `string`&gt;
#### Returns
@@ -317,13 +419,15 @@ object insertion order is easy to get wrong and `Map` is more foolproof.
### toArray()
> **toArray**(`options`?): `Promise`&lt;`any`[]&gt;
```ts
toArray(options?): Promise<any[]>
```
Collect the results as an array of objects.
#### Parameters
**options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
#### Returns
@@ -337,13 +441,15 @@ Collect the results as an array of objects.
### toArrow()
> **toArrow**(`options`?): `Promise`&lt;`Table`&lt;`any`&gt;&gt;
```ts
toArrow(options?): Promise<Table<any>>
```
Collect the results as an Arrow
#### Parameters
**options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
* **options?**: `Partial`&lt;`QueryExecutionOptions`&gt;
#### Returns
@@ -361,7 +467,9 @@ ArrowTable.
### where()
> **where**(`predicate`): `this`
```ts
where(predicate): this
```
A filter statement to be applied to this query.
@@ -369,7 +477,7 @@ The filter should be supplied as an SQL query string. For example:
#### Parameters
**predicate**: `string`
* **predicate**: `string`
#### Returns
@@ -389,3 +497,25 @@ on the filter column(s).
#### Inherited from
[`QueryBase`](QueryBase.md).[`where`](QueryBase.md#where)
***
### withRowId()
```ts
withRowId(): this
```
Whether to return the row id in the results.
This column can be used to match results between different queries. For
example, to match results from a full text search and a vector search in
order to perform hybrid search.
#### Returns
`this`
#### Inherited from
[`QueryBase`](QueryBase.md).[`withRowId`](QueryBase.md#withrowid)