rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-05-29 18:00:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

19
docs/src/js/functions/connect.md
View File

@@ -8,7 +8,9 @@
## connect(uri, opts)
> **connect**(`uri`, `opts`?): `Promise`<[`Connection`](../classes/Connection.md)>
```ts
function connect(uri, opts?): Promise<Connection>
```
Connect to a LanceDB instance at the given URI.
@@ -20,12 +22,11 @@ Accepted formats:
### Parameters
• **uri**: `string`
* **uri**: `string`
The uri of the database. If the database uri starts
with `db://` then it connects to a remote database.
The uri of the database. If the database uri starts
with `db://` then it connects to a remote database.
• **opts?**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md) \| `RemoteConnectionOptions`&gt;
* **opts?**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md)&gt;
### Returns
@@ -50,7 +51,9 @@ const conn = await connect(
## connect(opts)
> **connect**(`opts`): `Promise`&lt;[`Connection`](../classes/Connection.md)&gt;
```ts
function connect(opts): Promise<Connection>
```
Connect to a LanceDB instance at the given URI.
@@ -62,7 +65,7 @@ Accepted formats:
### Parameters
• **opts**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md) \| `RemoteConnectionOptions`&gt; & `object`
* **opts**: `Partial`&lt;[`ConnectionOptions`](../interfaces/ConnectionOptions.md)&gt; & `object`
### Returns

13
docs/src/js/functions/makeArrowTable.md
View File

@@ -6,7 +6,12 @@
# Function: makeArrowTable()
> **makeArrowTable**(`data`, `options`?, `metadata`?): `ArrowTable`
```ts
function makeArrowTable(
data,
options?,
metadata?): ArrowTable
```
An enhanced version of the makeTable function from Apache Arrow
that supports nested fields and embeddings columns.
@@ -40,11 +45,11 @@ rules are as follows:
## Parameters
• **data**: `Record`&lt;`string`, `unknown`&gt;[]
* **data**: `Record`&lt;`string`, `unknown`&gt;[]
• **options?**: `Partial`&lt;[`MakeArrowTableOptions`](../classes/MakeArrowTableOptions.md)&gt;
* **options?**: `Partial`&lt;[`MakeArrowTableOptions`](../classes/MakeArrowTableOptions.md)&gt;
• **metadata?**: `Map`&lt;`string`, `string`&gt;
* **metadata?**: `Map`&lt;`string`, `string`&gt;
## Returns