rust/lancedb
1
0
Fork 0
mirror of https://github.com/lancedb/lancedb.git synced 2026-01-03 18:32:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] fixed javascript docs for overloaded functions (#247)

Browse Source 
Solves #244 :


![image](https://github.com/lancedb/lancedb/assets/43097991/d1fd9d2a-0d6a-4c16-a0ab-f460cc709349)

Problem was function overloading in the interface caused some weird
`typedoc` formatting, so breaking it apart into methods fixed the issue.

Also regenerated and updated javascript docs

---------

Co-authored-by: Tevin Wang <tevin@cmu.edu>
This commit is contained in:
Leon Yee
2023-07-04 13:07:34 -07:00
committed by GitHub
parent 148ed82607
commit 9600a38ff0
14 changed files with 262 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/src/javascript/classes/LocalTable.md
View File

@@ -2,7 +2,7 @@
# Class: LocalTable<T\>
A LanceDB table that allows you to search and update a table.
A LanceDB Table is the collection of Records. Each Record has one or more vector fields.
## Type parameters
@@ -60,7 +60,7 @@ A LanceDB table that allows you to search and update a table.
#### Defined in
[index.ts:212](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L212)
[index.ts:221](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L221)
• **new LocalTable**<`T`\>(`tbl`, `name`, `embeddings`)
@@ -80,7 +80,7 @@ A LanceDB table that allows you to search and update a table.
#### Defined in
[index.ts:218](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L218)
[index.ts:227](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L227)
## Properties
@@ -90,7 +90,7 @@ A LanceDB table that allows you to search and update a table.
#### Defined in
[index.ts:210](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L210)
[index.ts:219](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L219)
___
@@ -100,7 +100,7 @@ ___
#### Defined in
[index.ts:209](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L209)
[index.ts:218](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L218)
___
@@ -110,7 +110,7 @@ ___
#### Defined in
[index.ts:208](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L208)
[index.ts:217](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L217)
## Accessors
@@ -128,7 +128,7 @@ ___
#### Defined in
[index.ts:225](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L225)
[index.ts:234](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L234)
## Methods
@@ -156,7 +156,7 @@ The number of rows added to the table
#### Defined in
[index.ts:243](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L243)
[index.ts:252](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L252)
___
@@ -176,7 +176,7 @@ Returns the number of rows in this table.
#### Defined in
[index.ts:269](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L269)
[index.ts:278](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L278)
___
@@ -206,7 +206,7 @@ VectorIndexParams.
#### Defined in
[index.ts:262](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L262)
[index.ts:271](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L271)
___
@@ -232,7 +232,7 @@ Delete rows from this table.
#### Defined in
[index.ts:278](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L278)
[index.ts:287](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L287)
___
@@ -260,7 +260,7 @@ The number of rows added to the table
#### Defined in
[index.ts:253](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L253)
[index.ts:262](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L262)
___
@@ -286,4 +286,4 @@ Creates a search query to find the nearest neighbors of the given search term
#### Defined in
[index.ts:233](https://github.com/lancedb/lancedb/blob/bfb5400/node/src/index.ts#L233)
[index.ts:242](https://github.com/lancedb/lancedb/blob/7247834/node/src/index.ts#L242)