mirror of
https://github.com/lancedb/lancedb.git
synced 2026-05-24 07:20:40 +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:
@@ -27,7 +27,9 @@ the underlying connection has been closed.
|
||||
|
||||
### new Connection()
|
||||
|
||||
> **new Connection**(): [`Connection`](Connection.md)
|
||||
```ts
|
||||
new Connection(): Connection
|
||||
```
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -37,7 +39,9 @@ the underlying connection has been closed.
|
||||
|
||||
### close()
|
||||
|
||||
> `abstract` **close**(): `void`
|
||||
```ts
|
||||
abstract close(): void
|
||||
```
|
||||
|
||||
Close the connection, releasing any underlying resources.
|
||||
|
||||
@@ -53,21 +57,24 @@ Any attempt to use the connection after it is closed will result in an error.
|
||||
|
||||
### createEmptyTable()
|
||||
|
||||
> `abstract` **createEmptyTable**(`name`, `schema`, `options`?): `Promise`<[`Table`](Table.md)>
|
||||
```ts
|
||||
abstract createEmptyTable(
|
||||
name,
|
||||
schema,
|
||||
options?): Promise<Table>
|
||||
```
|
||||
|
||||
Creates a new empty Table
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **name**: `string`
|
||||
* **name**: `string`
|
||||
The name of the table.
|
||||
|
||||
The name of the table.
|
||||
* **schema**: `SchemaLike`
|
||||
The schema of the table
|
||||
|
||||
• **schema**: `SchemaLike`
|
||||
|
||||
The schema of the table
|
||||
|
||||
• **options?**: `Partial`<[`CreateTableOptions`](../interfaces/CreateTableOptions.md)>
|
||||
* **options?**: `Partial`<[`CreateTableOptions`](../interfaces/CreateTableOptions.md)>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -79,15 +86,16 @@ The schema of the table
|
||||
|
||||
#### createTable(options)
|
||||
|
||||
> `abstract` **createTable**(`options`): `Promise`<[`Table`](Table.md)>
|
||||
```ts
|
||||
abstract createTable(options): Promise<Table>
|
||||
```
|
||||
|
||||
Creates a new Table and initialize it with new data.
|
||||
|
||||
##### Parameters
|
||||
|
||||
• **options**: `object` & `Partial`<[`CreateTableOptions`](../interfaces/CreateTableOptions.md)>
|
||||
|
||||
The options object.
|
||||
* **options**: `object` & `Partial`<[`CreateTableOptions`](../interfaces/CreateTableOptions.md)>
|
||||
The options object.
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -95,22 +103,25 @@ The options object.
|
||||
|
||||
#### createTable(name, data, options)
|
||||
|
||||
> `abstract` **createTable**(`name`, `data`, `options`?): `Promise`<[`Table`](Table.md)>
|
||||
```ts
|
||||
abstract createTable(
|
||||
name,
|
||||
data,
|
||||
options?): Promise<Table>
|
||||
```
|
||||
|
||||
Creates a new Table and initialize it with new data.
|
||||
|
||||
##### Parameters
|
||||
|
||||
• **name**: `string`
|
||||
* **name**: `string`
|
||||
The name of the table.
|
||||
|
||||
The name of the table.
|
||||
* **data**: `TableLike` \| `Record`<`string`, `unknown`>[]
|
||||
Non-empty Array of Records
|
||||
to be inserted into the table
|
||||
|
||||
• **data**: `TableLike` \| `Record`<`string`, `unknown`>[]
|
||||
|
||||
Non-empty Array of Records
|
||||
to be inserted into the table
|
||||
|
||||
• **options?**: `Partial`<[`CreateTableOptions`](../interfaces/CreateTableOptions.md)>
|
||||
* **options?**: `Partial`<[`CreateTableOptions`](../interfaces/CreateTableOptions.md)>
|
||||
|
||||
##### Returns
|
||||
|
||||
@@ -120,7 +131,9 @@ to be inserted into the table
|
||||
|
||||
### display()
|
||||
|
||||
> `abstract` **display**(): `string`
|
||||
```ts
|
||||
abstract display(): string
|
||||
```
|
||||
|
||||
Return a brief description of the connection
|
||||
|
||||
@@ -132,15 +145,16 @@ Return a brief description of the connection
|
||||
|
||||
### dropTable()
|
||||
|
||||
> `abstract` **dropTable**(`name`): `Promise`<`void`>
|
||||
```ts
|
||||
abstract dropTable(name): Promise<void>
|
||||
```
|
||||
|
||||
Drop an existing table.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **name**: `string`
|
||||
|
||||
The name of the table to drop.
|
||||
* **name**: `string`
|
||||
The name of the table to drop.
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -150,7 +164,9 @@ The name of the table to drop.
|
||||
|
||||
### isOpen()
|
||||
|
||||
> `abstract` **isOpen**(): `boolean`
|
||||
```ts
|
||||
abstract isOpen(): boolean
|
||||
```
|
||||
|
||||
Return true if the connection has not been closed
|
||||
|
||||
@@ -162,17 +178,18 @@ Return true if the connection has not been closed
|
||||
|
||||
### openTable()
|
||||
|
||||
> `abstract` **openTable**(`name`, `options`?): `Promise`<[`Table`](Table.md)>
|
||||
```ts
|
||||
abstract openTable(name, options?): Promise<Table>
|
||||
```
|
||||
|
||||
Open a table in the database.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **name**: `string`
|
||||
* **name**: `string`
|
||||
The name of the table
|
||||
|
||||
The name of the table
|
||||
|
||||
• **options?**: `Partial`<`OpenTableOptions`>
|
||||
* **options?**: `Partial`<`OpenTableOptions`>
|
||||
|
||||
#### Returns
|
||||
|
||||
@@ -182,7 +199,9 @@ The name of the table
|
||||
|
||||
### tableNames()
|
||||
|
||||
> `abstract` **tableNames**(`options`?): `Promise`<`string`[]>
|
||||
```ts
|
||||
abstract tableNames(options?): Promise<string[]>
|
||||
```
|
||||
|
||||
List all the table names in this database.
|
||||
|
||||
@@ -190,10 +209,9 @@ Tables will be returned in lexicographical order.
|
||||
|
||||
#### Parameters
|
||||
|
||||
• **options?**: `Partial`<[`TableNamesOptions`](../interfaces/TableNamesOptions.md)>
|
||||
|
||||
options to control the
|
||||
paging / start point
|
||||
* **options?**: `Partial`<[`TableNamesOptions`](../interfaces/TableNamesOptions.md)>
|
||||
options to control the
|
||||
paging / start point
|
||||
|
||||
#### Returns
|
||||
|
||||
|
||||
Reference in New Issue
Block a user