From 98830516cd0c544c848a69bc030574f0c5ad33c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mika=C3=ABl=20Francoeur?= Date: Tue, 1 Jul 2025 10:52:41 -0400 Subject: [PATCH] fix typos and format md tables with prettier --- bindings/javascript/docs/API.md | 31 ++++++++++++------------ bindings/javascript/docs/CONTRIBUTING.md | 2 +- 2 files changed, 17 insertions(+), 16 deletions(-) diff --git a/bindings/javascript/docs/API.md b/bindings/javascript/docs/API.md index b3aa865d9..b8cd43a09 100644 --- a/bindings/javascript/docs/API.md +++ b/bindings/javascript/docs/API.md @@ -22,9 +22,9 @@ The function returns a `Database` object. Prepares a SQL statement for execution. -| Param | Type | Description | -| ------ | ------------------- | ------------------------------------ | -| sql | string | The SQL statement string to prepare. | +| Param | Type | Description | +| ----- | ------------------- | ------------------------------------ | +| sql | string | The SQL statement string to prepare. | The function returns a `Statement` object. @@ -74,19 +74,19 @@ This function is currently not supported. ### loadExtension(path, [entryPoint]) ⇒ this -Loads a SQLite3 extension +Loads a SQLite3 extension. -| Param | Type | Description | -| ------ | ------------------- | -----------------------------------------| -| path | string | The path to the extention to be loaded. | +| Param | Type | Description | +| ----- | ------------------- | --------------------------------------- | +| path | string | The path to the extension to be loaded. | ### exec(sql) ⇒ this Executes a SQL statement. -| Param | Type | Description | -| ------ | ------------------- | ------------------------------------ | -| sql | string | The SQL statement string to execute. | +| Param | Type | Description | +| ----- | ------------------- | ------------------------------------ | +| sql | string | The SQL statement string to execute. | This can execute strings that contain multiple SQL statements. @@ -110,7 +110,7 @@ Closes the database connection. Executes the SQL statement and (currently) returns an array with results. -**Note:** It should return an info object. +**Note:** It should return an info object. | Param | Type | Description | | -------------- | ----------------------------- | ------------------------------------------------ | @@ -148,9 +148,9 @@ Executes the SQL statement and returns an iterator to the resulting rows. Makes the prepared statement only return the value of the first column of any rows that it retrieves. -| Param | Type | Description | -| -------------- | ----------------------------- | ------------------------------------------------ | -| pluckMode | boolean | Enable of disable pluck mode. If you don't pass the paramenter, pluck mode is enabled. | +| Param | Type | Description | +| --------- | -------------------- | -------------------------------------------------------------------------------------- | +| pluckMode | boolean | Enable of disable pluck mode. If you don't pass the paramenter, pluck mode is enabled. | ```js stmt.pluck(); // plucking ON @@ -194,4 +194,5 @@ This function is currently not supported. | -------------- | ----------------------------- | ------------------------------------------------ | | bindParameters | array of objects | The bind parameters for executing the statement. | -Binds **permanently** the given parameters to the statement. After a statement's parameters are bound this way, you may no longer provide it with execution-specific (temporary) bound parameters. \ No newline at end of file +Binds **permanently** the given parameters to the statement. After a statement's parameters are bound this way, you may no longer provide it with execution-specific (temporary) bound parameters. + diff --git a/bindings/javascript/docs/CONTRIBUTING.md b/bindings/javascript/docs/CONTRIBUTING.md index 27b071dbb..b7c3c2a28 100644 --- a/bindings/javascript/docs/CONTRIBUTING.md +++ b/bindings/javascript/docs/CONTRIBUTING.md @@ -2,7 +2,7 @@ So you want to contribute to Limbo's binding for the ~second~ best language in the world? Awesome. -First things first you'll need to install [napi-rs](https://napi.rs/), follow the instructions [here](https://napi.rs/docs/introduction/getting-started) althought is highly recommended to use `yarn` with: +First things first you'll need to install [napi-rs](https://napi.rs/), follow the instructions [here](https://napi.rs/docs/introduction/getting-started) although is highly recommended to use `yarn` with: ```sh yarn global add @napi-rs/cli