mirror of
https://github.com/lancedb/lancedb.git
synced 2026-05-27 08:50:39 +00:00
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:
@@ -12,11 +12,13 @@ Options to control the makeArrowTable call.
|
||||
|
||||
### new MakeArrowTableOptions()
|
||||
|
||||
> **new MakeArrowTableOptions**(`values`?): [`MakeArrowTableOptions`](MakeArrowTableOptions.md)
|
||||
```ts
|
||||
new MakeArrowTableOptions(values?): MakeArrowTableOptions
|
||||
```
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **values?**: `Partial`<[`MakeArrowTableOptions`](MakeArrowTableOptions.md)>
|
||||
* **values?**: `Partial`<[`MakeArrowTableOptions`](MakeArrowTableOptions.md)>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -26,7 +28,9 @@ Options to control the makeArrowTable call.
|
||||
|
||||
### dictionaryEncodeStrings
|
||||
|
||||
> **dictionaryEncodeStrings**: `boolean` = `false`
|
||||
```ts
|
||||
dictionaryEncodeStrings: boolean = false;
|
||||
```
|
||||
|
||||
If true then string columns will be encoded with dictionary encoding
|
||||
|
||||
@@ -40,22 +44,30 @@ If `schema` is provided then this property is ignored.
|
||||
|
||||
### embeddingFunction?
|
||||
|
||||
> `optional` **embeddingFunction**: [`EmbeddingFunctionConfig`](../namespaces/embedding/interfaces/EmbeddingFunctionConfig.md)
|
||||
```ts
|
||||
optional embeddingFunction: EmbeddingFunctionConfig;
|
||||
```
|
||||
|
||||
***
|
||||
|
||||
### embeddings?
|
||||
|
||||
> `optional` **embeddings**: [`EmbeddingFunction`](../namespaces/embedding/classes/EmbeddingFunction.md)<`unknown`, `FunctionOptions`>
|
||||
```ts
|
||||
optional embeddings: EmbeddingFunction<unknown, FunctionOptions>;
|
||||
```
|
||||
|
||||
***
|
||||
|
||||
### schema?
|
||||
|
||||
> `optional` **schema**: `SchemaLike`
|
||||
```ts
|
||||
optional schema: SchemaLike;
|
||||
```
|
||||
|
||||
***
|
||||
|
||||
### vectorColumns
|
||||
|
||||
> **vectorColumns**: `Record`<`string`, [`VectorColumnOptions`](VectorColumnOptions.md)>
|
||||
```ts
|
||||
vectorColumns: Record<string, VectorColumnOptions>;
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user