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
@@ -6,13 +6,15 @@
# Function: LanceSchema()
> **LanceSchema**(`fields`): `Schema`
```ts
function LanceSchema(fields): Schema
```
Create a schema with embedding functions.
## Parameters
**fields**: `Record`<`string`, `object` \| [`object`, `Map`<`string`, [`EmbeddingFunction`](../classes/EmbeddingFunction.md)<`any`, `FunctionOptions`>>]>
* **fields**: `Record`<`string`, `object` \| [`object`, `Map`<`string`, [`EmbeddingFunction`](../classes/EmbeddingFunction.md)<`any`, `FunctionOptions`>>]>
## Returns
@@ -6,7 +6,9 @@
# Function: getRegistry()
> **getRegistry**(): [`EmbeddingFunctionRegistry`](../classes/EmbeddingFunctionRegistry.md)
```ts
function getRegistry(): EmbeddingFunctionRegistry
```
Utility function to get the global instance of the registry
@@ -6,11 +6,13 @@
# Function: register()
> **register**(`name`?): (`ctor`) => `any`
```ts
function register(name?): (ctor) => any
```
## Parameters
**name?**: `string`
* **name?**: `string`
## Returns
@@ -18,7 +20,7 @@
### Parameters
**ctor**: `EmbeddingFunctionConstructor`<[`EmbeddingFunction`](../classes/EmbeddingFunction.md)<`any`, `FunctionOptions`>>
* **ctor**: `EmbeddingFunctionConstructor`<[`EmbeddingFunction`](../classes/EmbeddingFunction.md)<`any`, `FunctionOptions`>>
### Returns