Skip to content

Commit 237831e

Browse files
committed
chore: Remove API reference section and update license links in README
1 parent efc04da commit 237831e

File tree

1 file changed

+4
-53
lines changed

1 file changed

+4
-53
lines changed

README.md

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,6 @@ console.log(`Database OK: ${status.ok}, Ping: ${status.ping}ms`)
153153
await db.close()
154154
```
155155

156-
## API Reference
157-
158156
### Constructor Options
159157

160158
```typescript
@@ -175,62 +173,15 @@ interface ClientOptions {
175173
}
176174
```
177175

178-
### Methods
179-
180-
- `query<T>(sql: string, args?: (string | number | boolean | null)[])` - Execute raw SQL with parameters
181-
- `findFirst<K>(table: K, where?: Partial<DT[K]>)` - Find first matching record
182-
- `findMany<K>(table: K, where?: Partial<DT[K]>)` - Find all matching records
183-
- `insert<K>(table: K, data: Partial<DT[K]>)` - Insert new record
184-
- `update<K>(table: K, data: Partial<DT[K]>, where: Partial<DT[K]>)` - Update records
185-
- `delete<K>(table: K, where: Partial<DT[K]>)` - Delete records
186-
- `deleteFirst<K>(table: K, where: Partial<DT[K]>)` - Delete first matching record
187-
- `status()` - Get server status and ping (HTTP driver only)
188-
- `close()` - Close database connections
189-
190-
### Return Types
191-
192-
All query methods return a unified result format:
193-
194-
```typescript
195-
type UnifiedQueryResult<T> = {
196-
rows: T[]
197-
rowCount: number
198-
command?: string
199-
fields?: Array<{ name: string; dataTypeID: number }>
200-
}
201-
```
202-
203-
## Development
204-
205-
<details>
206-
207-
<summary>local development</summary>
208-
209-
- Clone this repository
210-
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
211-
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
212-
- Install dependencies using `pnpm install`
213-
- Run interactive tests using `pnpm dev`
214-
215176
</details>
216177

217178
## License
218179

219180
<!-- automd:contributors license=MIT -->
220181

221-
Published under the [MIT](https://github.com/lassejlv/postgres-http-js/blob/main/LICENSE) license.
222-
Made by [community](https://github.com/lassejlv/postgres-http-js/graphs/contributors) 💛
182+
Published under the [MIT](https://github.com/lassejlv/driftsql/blob/main/LICENSE) license.
183+
Made by [community](https://github.com/lassejlv/driftsql/graphs/contributors) 💛
223184
<br><br>
224-
<a href="https://github.com/lassejlv/postgres-http-js/graphs/contributors">
225-
<img src="https://contrib.rocks/image?repo=lassejlv/postgres-http-js" />
185+
<a href="https://github.com/lassejlv/driftsql/graphs/contributors">
186+
<img src="https://contrib.rocks/image?repo=lassejlv/driftsql" />
226187
</a>
227-
228-
<!-- /automd -->
229-
230-
<!-- automd:with-automd -->
231-
232-
---
233-
234-
_🤖 auto updated with [automd](https://automd.unjs.io)_
235-
236-
<!-- /automd -->

0 commit comments

Comments
 (0)